Sign in

v1

latestOpenAPI 3.1.02026-07-263436159.3 KB
SubscriptionProduct

Create a subscription product

Creates a reusable subscription product template that can be used to create multiple subscriptions with the same configuration.

post/v1/subscription-products

Request body

channelstring nullable

Payment channel/method

authorizationTypestring nullable

Authorization type

frequencystring nullable

Payment frequency

notificationUrlstring uri required

Webhook URL for receiving events

countrystring required

ISO country code

automaticScheduleAllowedboolean
descriptionstring nullable
languagestring required

ISO language code

internalReferenceIdstring nullable
metadataobject nullable

Example request

{
  "channel": "PIX",
  "authorizationType": "BACKGROUND",
  "frequency": "MONTHLY",
  "retryPolicy": {
    "type": "PIX_SPECIFIC",
    "maxRetries": 5,
    "retryIntervalDays": 2
  },
  "amount": {
    "type": "FIXED",
    "fixedValue": 10000,
    "minValue": 5000,
    "maxValue": 50000,
    "currency": "BRL"
  }
}

Response

Product created successfully

statusboolean

Indicates if the request was successful

Example response

{
  "data": {
    "retryPolicy": {
      "type": "PIX_SPECIFIC",
      "maxRetries": 5,
      "retryIntervalDays": 2
    },
    "amount": {
      "type": "FIXED",
      "fixedValue": 10000,
      "minValue": 5000,
      "maxValue": 50000,
      "currency": "BRL"
    }
  }
}