POST /purchases

Creates a purchase

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string

Specifies the merchant on whose behalf the request is being made. Include this parameter if the request is being performed by a platform organization that is acting on behalf of one of its merchants. Without this parameter, operations initiated by a platform organization will default to being associated with the platform itself.

Body Params
string
required

Identifier of the plan that defines the subscription rules (frequency, billing cycles, amount, etc.).

string
required

Identifier of the customer associated with this purchase.

string

Unique identifier of the purchase in your system. Used for idempotency and reconciliation.

string

Identifier of a coupon to apply discounts to the purchase.

string

Identifier of a billing configuration. Determines the retry preferences to follow when a charge fails.
Behaviour:
• If provided → the purchase follows this specific configuration.
• If not provided and the organization has a default configuration → the purchase follows that default retry preference.
• If not provided and no default configuration exists → the purchase follows Uelz’s retry default: 3 retries with 2-day intervals each.

string
Defaults to EUR

Currency in which the purchase is billed. Defaults to EUR. Must be an ISO 4217 code (e.g. USD, EUR). if not provided, pruchase will take currency defined in plan

string

Token representing the customer’s payment method, usually created in external checkout.

date

Date when the purchased service is considered activated. Used when the plan has has_service_activation_date=true. Billing will only start on or after this date.

date

Date when the purchase or subscription should automatically end. Useful for fixed-term contracts. The plans can not have billing cycles for this attribute to be used.

Headers
string
string
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json