API Reference
Support

Create a new subscription

post
https://api.payretailers.com/v1/subscriptions

Creates a new subscription for recurring payments. Supports two authorization journeys: BACKGROUND (push notification) and USER_INTERACTION (QR code scan).

Body Params
uuid | null

ID of a pre-configured subscription product. If provided, inherits product configuration.

customer
object
required
string
required

Payment channel/method. Valid values: PIX (PIX Automatic), WALLET (coming soon), SPEI (coming soon).

string
required

Authorization type. Valid values: BACKGROUND (Journey 1 - push notification, requires authorizationDetails), USER_INTERACTION (Journey 2 - QR code scan). INITIAL_PAYMENT (Journey 3 - Subscription and a First Immediate Payment)

string
required

Payment frequency. Valid values: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL.

retryPolicy
object
required
initialPayment
object
date-time | null

Subscription start date in ISO 8601 format

date-time | null

Subscription expiration date in ISO 8601 format

amount
object
required
uri
required

Webhook URL for receiving subscription and payment events. Must be HTTPS.

string
required
length between 2 and 2

ISO country code (2 characters)

boolean
Defaults to false

Whether payments should be automatically scheduled

string | null

Description of the subscription

string
required
length between 2 and 2

ISO language code (2 characters)

string | null

Your internal reference ID for this subscription

metadata
object | null

Custom metadata key-value pairs

Responses

Updated 5 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago