Create subscription

POST

api

payments

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "customer": "<string>",
  "current_period_start": 123,
  "current_period_end": 123,
  "latest_invoice": "<string>",
  "client_secret": "<string>"
}

Authorizations

X-Auth-Token

string

header

required

API token generated at Settings > API

Body

application/json

price_id

string

required

Stripe price ID for the subscription plan

Example:

"price_1abc123"

string<email>

Customer email address

metadata

object

Additional metadata to attach to the subscription

Show child attributes

Response

Subscription created

string

Stripe subscription ID

status

enum<string>

Subscription status

Available options:

active,

incomplete,

incomplete_expired,

trialing,

past_due,

canceled,

unpaid,

paused

customer

string

Stripe customer ID

current_period_start

integer

Unix timestamp of current billing period start

current_period_end

integer

Unix timestamp of current billing period end

latest_invoice

string

Latest Stripe invoice ID

client_secret

string | null

Client secret for completing payment if required

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "customer": "<string>",
  "current_period_start": 123,
  "current_period_end": 123,
  "latest_invoice": "<string>",
  "client_secret": "<string>"
}

Overview

Partner API

Templates

Thumbnails

Submissions

Submitters

Users

Access Tokens

Webhooks

Settings

Custom Domains

Teams

Audit Events

MFA

BAA

Security Events

Subscriptions

Plans

Payments

Verification

KBA

AI

Embed

Health

Create subscription

Authorizations

Body

Response