Skip to main content
POST
Create a pending subscription

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new SubscriptionProfile resource

stripeCustomerId
string | null
stripeSubscriptionId
string | null
createdAt
string<date-time>
status
string | null
uid
string | null
requestPayload
(string | null)[] | null
localCenterOption
object | null

Response

SubscriptionProfile resource created

id
integer
read-only
member
object | null
productPrice
object | null
currency
string | null
currentPeriodEnd
string<date-time> | null
stripeCustomerId
string | null
stripeSubscriptionId
string | null
isSubscriptionInactive
boolean | null
createdAt
string<date-time>
isSubscriptionCanceled
boolean | null
customPriceValue
integer | null
contact
object | null
status
string | null
uid
string | null
isPublic
boolean | null
identity
object | null
identityReminderSent
boolean | null
localCenterOption
object | null
identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null