Create a subscription

post

https://api.confirmo.com/api/v3/subscriptions

Subscribes a subscriber (by email) to one of your plans. Starts in
PENDING until the subscriber completes checkout. Pass
customerProfile to supply Travel Rule / AML customer data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

planId

uuid

required

subscriber

object

required

customerProfile

Optional customer profile, used to meet Travel Rule / AML obligations.
profileId is returned as Subscription.customerProfileId; the rest
of the profile is write-only and never returned by the API.

EU merchants: merchants operating under the EU regulatory workflow
must supply a complete customer profile with every subscription, to meet
Travel Rule / AML obligations. The profile must be an individual (with
firstName, lastName, dateOfBirth, and a full address —
streetAddress, city, postalCode, country) or a company (with
registeredName, registrationNumber, and a full address); a
reference profile is not accepted. A missing or incomplete profile is
rejected with HTTP 422 and error code CUSTOMER_PROFILE_REQUIRED. For
other merchants the profile remains optional.

amount

string

^\d+(\.\d+)?$

Per-subscription amount (value only; asset comes from the plan).
Required when the plan is VARIABLE; must be omitted when the plan is FIXED.

notifyUrl

uri

Webhook URL (http/https, max 2048 chars) for lifecycle and payment events.

returnUrl

uri

Where the subscriber is redirected after completing or exiting checkout (http/https, max 2048 chars).

Responses

201Subscription created.

400Request is malformed or violates a validation rule.

401Caller is unauthenticated.

403Caller is authenticated but not authorized for this resource.

404Resource not found.

409Request conflicts with the current resource state.

422Request parsed but violates a business rule or invariant.

500Unexpected server error.