There are many situations where you might want to apply a Credit to a Subscription. For example, a customer might ask to:
- Temporarily reduce the subscription amount for the next charge
- Request a temporary pause for 1-2 months on being billed
- Apply a one-time credit for an issue that may have occcurred
Apply Credits to a Subscription using the Dashboard
Steps to Apply a Credit:
- Navigate to an Active Subscription
- Click into a Subscription and find the Billing Credit Section
- Create a Credit
Once the Credit is created, you'll be able to see all the Credits for that Subscription.
Note: Applying Credits are irreversible.
Apply Credits to a Subscription using the Finix API
If you are interesting in applying a credit using the Finix API, you can use the structure below.
Request:
curl https://finix.sandbox-payments-api.com/subscriptions/subscription_cmhURdrg2KX5Kp1emKdvh/subscription_balance_entries \
-H 'Content-Type: application/json' \
-H 'Finix-Version: 2022-02-01' \
-u USksBJMwkNUz5GyxPevL2yFY:71b641c1-861d-435b-9a9c-532760731c5e \
-X POST \
-d '{
"type": "CREDIT",
"amount": 1000,
"currency": "USD",
"description": "10.00 credit due to order issue",
"tags": {}
}'
Response:
{
"id" : "subscription_balance_entry_cmhV4HNbhJJ242SRNqcH9",
"created_at" : "2025-03-19T19:00:30.25Z",
"updated_at" : "2025-03-19T19:00:30.25Z",
"type" : "CREDIT",
"subscription_id" : "subscription_cmhURdrg2KX5Kp1emKdvh",
"amount" : 1000,
"currency" : "USD",
"description" : "10.00 credit due to order issue",
"tags" : { }
}