Get a credit pack purchase · SocialTap API reference

A purchase POST /v1/billing/checkout started for this account, as Stripe has it, and whether its credits were added (a paid one's are, once, by the time it answers). Poll while open. Other accounts' sessions are not_found. Free.

Auth: an API key with the account:read scope, or the dashboard session.

Test mode: Answers a test key's placeholder session as open.

Example

cURL

curl 'https://staging.socialtap.dev/v1/billing/checkout/<id>' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Path parameters

Name	Type	Description	Example
`id` required	`string`	Checkout session ID (cs_…).	—

idstringrequired

Checkout session ID (cs_…).

Response

application/json

200

Get a credit pack purchase

Field	Type	Description
`data`	`object`
`data.amount_total`	`integer` or `null`	Paid, tax included, in the currency's smallest unit; null until known.
`data.credits`	`integer`	Credits the pack adds.
`data.credits_added`	`boolean`	Whether the pack's credits were added (once). A later refund or dispute takes back what is unspent.
`data.currency`	`string` or `null`	amount_total's currency (ISO 4217); null until known.
`data.id`	`string`	Checkout session ID (cs_…).
`data.object`	`string`	Always checkout_session. One of `checkout_session`
`data.pack`	`string`	The credit pack bought (catalog pack ID).
`data.payment_status`	`string`	paid once captured; a complete session stays unpaid while a delayed payment clears. One of `paid`, `unpaid`, `no_payment_required`
`data.status`	`string`	open (not paid yet), complete (checkout finished) or expired (abandoned, nothing charged). One of `open`, `complete`, `expired`
`meta`	`object`	The shared route meta (see the API reference introduction).

dataobject

Show 9 child fields

amount_totalintegernullable

Paid, tax included, in the currency's smallest unit; null until known.

creditsinteger

Credits the pack adds.

credits_addedboolean

Whether the pack's credits were added (once). A later refund or dispute takes back what is unspent.

currencystringnullable

amount_total's currency (ISO 4217); null until known.

idstring

Checkout session ID (cs_…).

objectstring

Always checkout_session.

One ofcheckout_session

packstring

The credit pack bought (catalog pack ID).

payment_statusstring

paid once captured; a complete session stays unpaid while a delayed payment clears.

One ofpaidunpaidno_payment_required

statusstring

open (not paid yet), complete (checkout finished) or expired (abandoned, nothing charged).

One ofopencompleteexpired

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

Code	HTTP	Retry	Meaning	What to do
`invalid_input`	400	No	The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.	Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

invalid_inputNo retry

The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.

Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

401

401 Unauthorized.

Code	HTTP	Retry	Meaning	What to do
`unauthorized`	401	No	The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).	Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

unauthorizedNo retry

The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).

Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

403

403 Forbidden.

Code	HTTP	Retry	Meaning	What to do
`forbidden`	403	No	The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.	Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

forbiddenNo retry

The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include; or the request used a rotated key's previous secret (or one no longer current) for something that needs the admin scope. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.

Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope) or the key's new secret after a rotation, have the owner confirm the emailed link, create a new key, or call from an allowed IP.

404

404 Not Found.

Code	HTTP	Retry	Meaning	What to do
`not_found`	404	No	The item does not exist or was deleted.	Check the URL or ID; do not retry.

not_foundNo retry

The item does not exist or was deleted.

Check the URL or ID; do not retry.

429

429 Too Many Requests.

Code	HTTP	Retry	Meaning	What to do
`rate_limited`	429	Yes, later	The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.	Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, later

The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.

Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

502

502 Bad Gateway.

Code	HTTP	Retry	Meaning	What to do
`upstream_error`	502	Yes, later	The platform failed or returned something unexpected.	Retry with backoff; failed requests are free.

upstream_errorYes, later

The platform failed or returned something unexpected.

Retry with backoff; failed requests are free.

Test mode

Answers a test key's placeholder session as open.

operationId billing.checkout.get