On this page:
https://api.premepay.com/v1/stores/{storeId}/subscriptions/{:id}/
<aside> 💡 Do you already have a Subscription Plan? You will be able to enroll users in Subscription Plans once you have an existing Subscription Plan.
</aside>
See below for how to update a subscription's information.
<aside> 💡 The subscription is non-transferable and it is not possible to update the customer id. In scenarios like this, cancel the current subscription and create a new one for the new customer.
</aside>
| Parameter | Type | Description | Required |
|---|---|---|---|
planId |
integer | Id of the Plan to which the subscription must be associated | Yes |
payment |
object | Payment method information | Yes |
type |
string | One of the options: Credit, Boleto, Pix |
Yes |
cardId |
integer | Indicates the ID of the card on which the charge will be made (previously registered) | If the billing type is Credit |
metadata |
dictionary<key, value> | Used to save miscellaneous information in dictionary format <key, value> | No |
includeFeeTransfer |
boolean | Indicates whether fees should be passed on to the consumer | No |
daysBetweenRetries |
integer | Number of days between billing retries | No |
maxRetries |
integer | Maximum number of retries | No |
Request example
This is an example of how submitting your request to reactivate a subscription plan should look like.
If your request has invalid creation parameters - for example, specifying an invalid field or value - you may receive an error response. Below is the complete list of possible error responses:
Related Content
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Create plan
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/e3aeb85f-a7e2-40f4-b805-7e883e3d72e2/DELETE.png" width="40px" /> DELETE - Delete plan customer
</aside>
