Start Stripe payment-method onboarding for the billing account

POST

/v1/account/payment-method/setup

const url = 'https://dev-api.infiniteaudience.ai/v1/account/payment-method/setup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"success_url":"https://example.com","cancel_url":"https://example.com","tier":"paygo","cadence":"monthly","commitment_term_months":0,"custom_commitment_amount_cents":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dev-api.infiniteaudience.ai/v1/account/payment-method/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "success_url": "https://example.com", "cancel_url": "https://example.com", "tier": "paygo", "cadence": "monthly", "commitment_term_months": 0, "custom_commitment_amount_cents": 1 }'

Creates a Stripe Checkout setup session for the Stripe customer linked to the source-routed billing account. It does not create or mutate a Stripe Subscription. Requires ‘account’ scope.

Authorizations

bearerAuth

Request Body^required

application/json

object

success_url

required

string format: uri

<= 2048 characters

cancel_url

required

string format: uri

<= 2048 characters

tier

string

Allowed values: paygo starter growth enterprise

cadence

string

Allowed values: monthly annual

commitment_term_months

integer

Allowed values: 0 12 24 36

custom_commitment_amount_cents

integer

>= 1

Responses

200

Hosted setup session

application/json

object

setup_url

required

string format: uri

session_id

required

string

billing_status

required

string

Allowed value: awaiting_payment_method

Example

{
  "billing_status": "awaiting_payment_method"
}

400

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

validation_error

{
  "error": "Bad Request",
  "code": "MISSING_SEGMENTS",
  "message": "segment_ids is required for filter audiences."
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

missing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}

409

Resource state conflicts with the request. For upload analysis this includes FILE_NOT_YET_UPLOADED.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "request_id": "example"
}

422

Request is structurally valid but the resource is in a state that prevents the operation (e.g. expired, pending, or not yet uploaded). See error and code for the specific reason.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Audience expired",
  "code": "AUDIENCE_EXPIRED",
  "message": "This audience version expired. Run a refresh to create a new deliverable version."
}

{
  "error": "Audience not ready",
  "code": "AUDIENCE_PENDING",
  "message": "This audience is still being processed. Poll GET /v1/audiences/{id} until status is active."
}

502

An upstream billing provider rejected or could not complete the operation.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "request_id": "example"
}

503

A required billing provider integration is temporarily unavailable.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "message": "example",
  "code": "example",
  "request_id": "example"
}

Start Stripe payment-method onboarding for the billing account

Authorizations

Request Bodyrequired

Responses

200

Example

400

Examples

401

Examples

403

Examples

409

Examplegenerated

422

Examples

502

Examplegenerated

503

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated