PApayretailers
SubscriptionProduct

Update a subscription product

Updates an existing subscription product.

put/v1/subscription-products/{subscriptionProductId}

Request

  • Base URL
    https://api.payretailers.com
  • URL
    https://api.payretailers.com/v1/subscription-products/{subscriptionProductId}
  • Auth
    HTTP basic

Path parameters

subscriptionProductIdstring uuid required

Unique identifier of the subscription product (UUID format)

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 updated successfully

dataunknown
statusboolean

Indicates if the request was successful

Changes

No recorded changes to this operation across all 1 revision of this API.