Skip to content

Area: Developers

POST

Confirm a plan and billing period

Path
/partners/domains/subscriptions/confirm
Auth
Partner token · partner server only
POST
/partners/domains/subscriptions/confirm
Code sample: cURL
# $SIGNED_PAYLOAD: the request claims as a JWT signed with your private key, see https://releva.ai/documentation/reference/partners/overview/#authentication
curl --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.

Media typeapplication/json
object
payload
required

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.

string

Example generated

{
"payload": "example"
}

Confirmed.

Media typeapplication/json
object
billingPeriod
required
object
id
integer
accountId
integer
start
string format: date-time
end
string format: date-time
trialDays
integer
createdAt
string format: date-time
updatedAt
string format: date-time

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.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "The 'subscriptionIds' field is required. The 'start' field is required. The 'end' field is required. The 'trialDays' field is required."
}

The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}