Skip to main content
POST
Create credit checkout

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
packageId
enum<string>

Credit package ID in camelCase form

Available options:
small,
medium,
large,
xl
package_id
enum<string>

Credit package ID in snake_case form

Available options:
small,
medium,
large,
xl
project_reference
string

Project UUID or slug for an owner-pays top-up: the project owner’s wallet and effective price apply. Naming a project also requires project.read on it.

projectId
string

Deprecated alias; use project_reference. Optional project ID or slug. When supplied for a gate other than projects, checks the project owner and requires project.read. The projects gate always checks the caller.

project_id
string

Deprecated alias; use project_reference. Optional project ID or slug. When supplied for a gate other than projects, checks the project owner and requires project.read. The projects gate always checks the caller.

successUrl
string<uri>

Checkout success redirect URL in camelCase form

success_url
string<uri>

Checkout success redirect URL in snake_case form

cancelUrl
string<uri>

Checkout cancellation redirect URL in camelCase form

cancel_url
string<uri>

Checkout cancellation redirect URL in snake_case form

Response

Stripe checkout session for a credit package top-up

status
enum<string>
required

Checkout creation status

Available options:
checkout_created
checkout_url
string<uri>
required

Stripe checkout URL for the credit purchase