Update subscription

Update service subscription and recurring payments. This service allows you to update your subscription data so that it does not lose continuity.

Post a update subscription

POST https://api.stage.localpayment.com/api/payin/subscriptions/:externalId

Headers

Name	Type	Description
Authorization*	String	Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

Request Body

Name	Type	Description
amount	String	Mandatory. Amount to charge to your end user.
card	OBJECT	Party Object. Payer deb card data.
card.name	String	Mandatory. Cardholder name, as printed on the front of the debitcard.
card.expirationMonth	String	Mandatory. Card expiration month. Format MM.
card.cvv	String	Mandatory. Card Verification Value
card.number	number	Mandatory. Card number (PAN)
card.expirationYear	String	Mandatory. Card expiration year. Format YYYY
autoRecurring	OBJECT	Subscription properties
autoRecurring.repetitions*	number	How many times this payment will be collected. *For recurrence on demand send the parameter with value=0
autoRecurring.type*	String	Defines the recurring interval unit. Valid values: day, month. *For recurrence on demand send the parameter with value=custom
autoRecurring.trialDays	number	Number of trial days of the subscription
discount	OBJECT	Apply discount to a subscription
discount.amount*	String	Amount to charge to your end user.
discount.period*	number	Period or number of payments to which the new amount will be charged. Allowed values: >= 1<= 12 (if the subscription is in MONTH) >= 1<= 12 (if the subscription is in DAY)
retry	OBJECT	Optional. Party Object. Payin retry
retry.repetitions*	number	Number of times the charge will be retried
retry.intervalUnit*	String	The time unit in which retries will be executed. Allowed values: "day" and "hour"
retry.intervalValue*	number	Interval at which retries will be performed. Defines the number of time units between retries.
dateToUpdate	String	Optional field, applies only when the requested update is required to apply to a future date. Format: YYYY-MM-DD
suspension	OBJECT	Optional. Temporarily suspend subscription
suspension.dateToStart	date	Suspension start date. Format: yyyy-MM-dd'T'HH:mm:ss
suspension.dateToEnd	date	Suspension end date. Format: yyyy-MM-dd'T'HH:mm:ss
suspension.reason	String	Reason for suspension of subscription
status	String	Send this field only in the update request when you want to immediately activate a suspended subscription. Fixed value: ACTIVE

200: OK Subscription successfully created

{
    "externalId": "564b161a-76ba-4a84-b5cf-583f2df8c377",
    "internalId": "52425bbd-b68b-4abc-9480-5ae88d53adb3",
    "status": {
        "code": "107",
        "description": "APPROVED",
        "detail": "Update subscription success"
    },
    "errors": []
}

400: Bad Request Wrong parameters (syntactic or semantic errors). status.code might give you more information about the errror (see our Payin status code table for a detailed description).

{
    "status": {
        "code": "400",
        "description": "ERROR",
        "detail": "Invalid operation"
    }
}

Update a subscription: Example request & response

Note that this request contains optional parameters and objects that can be updated in the subscription.

JSON: Example request

{
   "dateToUpdate": "2025-01-30",
   "amount": 16000.0,

   "autoRecurring": {
        "repetitions": "3",
        "type": "month",
        "trialDays": "0"
    },

   "retry": {
    "repetitions": 2,
    "intervalUnit": "day",
    "intervalValue": 1
  }
}

Curl: Example request

curl --location --request PATCH 'https://api.stage.localpayment.com/api/payin/subscriptions/564b161a-76ba-4a84-b5cf-583f2df8c377' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzM4MDY2MTk5LCJqdGkiOiIxZjc3MGQ5M2E0Yjg0NzNhOWIzZDJkYjlhZDIxOWNhZCIsInVzZXJfaWQiOjMwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjpmYWxzZSwicm9sZXMiOlsiQURNSU4iXSwiY291bnRyaWVzIjpbIkFMTCJdLCJjb21wYW55IjoiMDAwMSIsImNsaWVudF9jb2RlIjoiMDAwMSJ9.DaZ3Fm0z65WZEzuOKCJtNLVitRcR0xBQElPyiYs8kXI' \
--data '{
    "dateToUpdate": "2025-01-30",
    "amount": 16000.0,

   "autoRecurring": {
        "repetitions": "3",
        "type": "month",
        "trialDays": "0"
    },

   "retry": {
    "repetitions": 2,
    "intervalUnit": "day",
    "intervalValue": 1
  }
}'

Example response: Status OK

{
    "externalId": "564b161a-76ba-4a84-b5cf-583f2df8c377",
    "internalId": "52425bbd-b68b-4abc-9480-5ae88d53adb3",
    "status": {
        "code": "107",
        "description": "APPROVED",
        "detail": "Update subscription success"
    },
    "errors": []
}