Billing

Generate checkout link (Stripe)

Creates a hosted Stripe checkout page and returns the url for the user to open in a browser — nothing is charged until they complete it there. purpose:“wallet_topup” (requires amount > 0, in the account currency) mints a one-time payment that credits the pre-paid wallet; purpose:“add_card” mints a page to save a card on file. Account-level action: requires a TENANT-scoped key (403 NUMBER_SCOPE_NOT_ALLOWED for a number key). Stripe only.

Requires a tenant-scoped key.

POST

billing

checkout

Generate checkout link (Stripe)

curl --request POST \
  --url https://pilotstatus.com.br/v1/billing/checkout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "purpose": "wallet_topup",
  "amount": 50
}
'

{
  "url": "https://checkout.stripe.com/c/pay/cs_test_...",
  "purpose": "wallet_topup",
  "orderId": "cto_01HZX...",
  "amount": 50,
  "currency": "BRL"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Body

application/json

purpose

string

required

What the checkout page is for.

Example:

"wallet_topup"

amount

string

Amount to credit to the wallet, in the account currency (required for wallet_topup).

Example:

"50"

successUrl

string

Redirect URL after success.

Example:

"https://app.acme.com/billing/ok"

cancelUrl

string

Redirect URL if cancelled.

Example:

"https://app.acme.com/billing"

Response

Top up wallet

Remove an extra number (On Demand)

Send message

⌘I

Generate checkout link (Stripe)

curl --request POST \
  --url https://pilotstatus.com.br/v1/billing/checkout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "purpose": "wallet_topup",
  "amount": 50
}
'

{
  "url": "https://checkout.stripe.com/c/pay/cs_test_...",
  "purpose": "wallet_topup",
  "orderId": "cto_01HZX...",
  "amount": 50,
  "currency": "BRL"
}