---
title: "Price a batch"
method: GET
path: "/v1/projects/{project}/plans/{plan}/access-codes/preview"
tags: ["Access Codes"]
---

# Price a batch

`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

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

```bash
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").

## Path parameters

- `project` string, uuid, required
- `plan` string, uuid, required

## Query parameters

- `quantity` integer, required

## Response `200`

The cost preview.

- object
  - `data` union, required: The response's payload.
    - object
      - `free_remaining` unknown, required
      - `chargeable_quantity` unknown, required
      - `cost` string, required: The worst-case charge for `chargeable_quantity`, as a decimal string in the billing currency.
      - `exceeds_threshold` boolean, required: Whether `cost` passes the confirmation threshold the dashboard warns at.
      - `threshold` union, required: That threshold, in the billing currency.
        - integer
        - number
    - object
      - `free_remaining` unknown, required
      - `chargeable_quantity` integer, required: How many of the batch would be metered if every one were redeemed.
      - `cost` '0', required: The worst-case charge for `chargeable_quantity`, as a decimal string in the billing currency.
      - `exceeds_threshold` boolean, required: Whether `cost` passes the confirmation threshold the dashboard warns at.
      - `threshold` union, required: That threshold, in the billing currency.
        - integer
        - number
    - object
      - `free_remaining` integer, required: Codes still covered by the tier's free allotment this cycle.
      - `chargeable_quantity` integer, required: How many of the batch would be metered if every one were redeemed.
      - `cost` '0', required: The worst-case charge for `chargeable_quantity`, as a decimal string in the billing currency.
      - `exceeds_threshold` boolean, required: Whether `cost` passes the confirmation threshold the dashboard warns at.
      - `threshold` number, required: That threshold, in the billing currency.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `422`: `VALIDATION_FAILED`: when `quantity` is missing or outside 1 to 1,000; `error.context.quantity` says so.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)