Access Codes

List a plan's access codes

Pages the plan's codes, newest first, fifty per page unless you say otherwise. status narrows the list to unredeemed, redeemed or expired codes; the default all returns every state.

Raw access_code values are always masked in API responses to the last 5 characters. Plaintext codes ship only through the creator dashboard CSV export or the per-code messages a batch can be delivered as.

get/v1/projects/{project}/plans/{plan}/access-codes

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/plans/{plan}/access-codes
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

planstring uuid required

The plan, resolved within the project by the route binder.

Query parameters

limitinteger

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

statusstring

Which codes to list: all (the default), unredeemed, redeemed or expired. An unknown value reads as all.

pageinteger

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 15.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

Response

The page.

Example response

{
  "data": [
    {
      "id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
      "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",
      "code_masked": "******12345",
      "expires_at": "2026-08-01T00:00:00Z",
      "created_at": "2026-05-18T10:05:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.