Skip to main content
PATCH
Accept a subscription profile

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.

Path Parameters

id
string
required

SubscriptionProfile identifier

Body

application/merge-patch+json

The updated SubscriptionProfile resource

member
string<iri-reference> | null
Example:

"/api/v1/users/1"

productPrice
string<iri-reference> | null
Example:

"/api/v1/product_prices/1"

currency
string | null
currentPeriodEnd
string<date-time> | null
stripeCustomerId
string | null
stripeSubscriptionId
string | null
isSubscriptionInactive
boolean | null
isFailedPayment
boolean | null
product
string<iri-reference>
Example:

"/api/v1/products/1"

createdAt
string<date-time>
isSubscriptionCanceled
boolean | null
customPriceValue
integer | null
contact
string<iri-reference> | null
Example:

"/api/v1/contacts/1"

tenant
string<iri-reference> | null
Example:

"/api/v1/tenants/1"

status
string | null
token
string | null
uid
string | null
acceptedBy
string<iri-reference> | null
Example:

"/api/v1/users/1"

acceptedDate
string<date-time> | null
isPublic
boolean | null
productOption
string<iri-reference> | null
Example:

"/api/v1/product_options/1"

requestPayload
(string | null)[] | null
identity
string<iri-reference> | null
Example:

"/api/v1/identities/1"

checkoutReminderSent
boolean | null
identityReminderSent
boolean | null
identityExpiringRequested
boolean | null
localCenterOption
string<iri-reference> | null
Example:

"/api/v1/local_centers/1"

identityReminder2Sent
boolean | null
identityReminder3Sent
boolean | null
commentByUser
string | null
hasCoveredProcessingFee
boolean | null

Response

SubscriptionProfile resource updated

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