The RecurringApplicationCharge resource facilitates a fixed-value, 30-day recurring charge. You can create an application charge by sending a request with the name the charge should appear under, the price your app is charging, and a return URL where Shoplazza redirects the merchant after the charge is accepted. After you've created the charge, redirect the merchant to the confirmation URL returned by Shoplazza. If the charge is declined, then Shoplazza redirects the merchant and provides a notification message that the app charge was declined. For step-by-step guidance that walks through this flow using examples, see our implementation guide.
For testing purposes you can include "test": true when creating the charge. This prevents the credit card from being charged. Test shops and demo shops cannot be charged.
Updating an application charge
Each shop can have only one recurring charge per app. When a new recurring application charge is activated for a shop that already has one, the existing recurring charge is canceled and replaced by the new charge. The new recurring charge is then activated.
For example, if you want to offer discounted pricing to a specific merchant, then you can create a new application charge for the shop. This will prompt the shop to accept the new charge in order to continue using the app. The new charge replaces the old billing going forward.
Recurring Application Charge
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the recurring application charge. |
| application_id | string | The Application ID of the recurring application charge. |
| name | string | The recurring application charge name. |
| price | string | The price of the recurring application charge. |
| return_url | string | The URL where the merchant is redirected after accepting a charge. |
| confirmation_url | string | The URL where the merchant accepts or declines the recurring application charge. |
| status | string | The status of the recurring application charge.pending, active, declined, expired,cancelled,paid_failed,paying |
| test | bool | Whether the application charge is a test transaction. |
| billing_on | string | The time of the next bill will be charged. |
| activated_on | string | The time of the bill be actived. |
| cancelled_on | string | The time of the bill be cancelled. |
| trial_days | int | The number of days that the customer is eligible for a free trial. |
| trial_ends_on | string | The date and time (ISO 8601 format) when the free trial ends. |
| created_at | string | The time this fulfillment created, ISO-8601 format |
| updated_at | date | The time this fulfillment last updated, ISO-8601 format |
| capped_amount | string | The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property. See usage charges for more information. |
| terms | string | The terms and conditions of usage based billing charges. Must be present in order to create usage charges, for example when the capped_amount property is provided. Presented to the merchant when they approve an app's usage charges. |