Confirm a plan and billing period
- Path
/partners/domains/subscriptions/confirm- Auth
- Partner token · partner server only
# $SIGNED_PAYLOAD: the request claims as a JWT signed with your private key, see https://releva.ai/documentation/reference/partners/overview/#authenticationcurl --request POST \ --url 'https://releva.ai/api/v0/partners/domains/subscriptions/confirm' \ --header 'content-type: application/json' \ --header "x-rlv-partner-token: $RELEVA_PARTNER_TOKEN" \ --data "{\"payload\": \"$SIGNED_PAYLOAD\"}"Activates the shop’s chosen domain subscriptions and records the billing period. subscriptionIds are the ids of
the shop’s domain subscriptions that Releva sent to your subscription change link (or passed in the sign-on link’s
subscriptionsToConfirm), not plan ids. All other active or inactive domain subscriptions of the shop are removed.
Billing periods: a new start creates a period; the same start as the current period updates its end and keeps
the larger trialDays (safe to repeat); a later start ends the current period one second earlier and starts a new
one; an earlier start is rejected. Also sets running: true and stores the price caps.
Only for partners with external billing.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
The request fields as JWT claims, signed with your RSA private key (RS512 recommended; RS256/384 and PS256/384/512
are also accepted) with a short expiry (expiresIn: '1h'). The operation’s x-signed-claims schema lists the
claims.
Example generated
{ "payload": "example"}Responses
Section titled “Responses”Confirmed.
object
object
Example
{ "billingPeriod": { "id": 4, "start": "2026-10-21T00:00:00.000Z", "end": "2026-11-20T23:59:59.000Z", "trialDays": 14, "accountId": 5, "createdAt": "2026-10-21T19:21:39.747Z", "updatedAt": "2026-10-21T19:21:39.747Z" }}Validation, billing mode, shop lookup or billing period error.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "The 'subscriptionIds' field is required. The 'start' field is required. The 'end' field is required. The 'trialDays' field is required."}{ "message": "The 'subscriptionIds[0]' field must be a number."}{ "message": "The start date of this subscription needs to be later than the start date of the last billing period. This is not supported!"}{ "message": "Partner Demo Partner Internal Billing it not allowed to use this API because it is not configured for external billing management. Actual value: internal"}The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}