Access Codes

Price a batch

Prices a batch of quantity codes without queuing it, so a caller can show the worst-case charge before generating.

curl "https://api.subscriby.net/v1/projects/$PROJECT/plans/$PLAN/access-codes/preview?quantity=50" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Generation is free. The metered overage is billed at redemption time, and only when your tier's free access-code allotment is already exhausted. Hand out codes freely; you only pay for the ones subscribers actually activate beyond the free quota.

The preview and the bulk-generate endpoint both return this cost breakdown so callers can surface the worst case ("if every one of these codes is redeemed, here is what you would owe").

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

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/plans/{plan}/access-codes/preview
  • 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

quantityinteger required

How many codes the batch would hold, 1 to 1,000.

Response

The cost preview.

Example response

{
  "data": {
    "free_remaining": 3,
    "chargeable_quantity": 47,
    "cost": "1.41",
    "threshold": 50
  }
}

Changes

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