Access Codes API
Access codes are pre-generated single-use subscription activations a creator hands out.
Access codes are pre-generated single-use subscription activations a creator hands out. Internally they are pending subscription rows that a subscriber redeems; redemption just claims the row. They live under the plan they activate, at /v1/projects/{project}/plans/{plan}/access-codes.
Endpoints
GET
/v1/projects/{project}/plans/{plan}/access-codesList a plan's access codesGET/v1/projects/{project}/plans/{plan}/access-codes/previewPrice a batchPOST/v1/projects/{project}/plans/{plan}/access-codes/bulk-generateGenerate a batch of codesDELETE/v1/projects/{project}/plans/{plan}/access-codes/{accessCode}Revoke an access codeRelated
Generate Access CodesCreate redeemable codes for free memberships, offline sales, giveaways, team access or influencer campaigns, with expiry rules, export and a quota.access_code.* eventsgenerated once per batch when the job completes, never per code; redeemed per code as subscribers claim them; expired per code when the reaper removes an unredeemed code past its expiry.Plans APIThe plan a code activates.
How is this guide?
Last updated on