Create Subscription plan
Outcome: Create a subscription plan that defines the characteristics of periodic subscription deductions per user.
Authorization
You should send a valid auth token as a Bearer Token.
Header Parameters
Bearer token authentication. Format: "Token YOUR_SECRET_KEY"
Body Parameters
Specify the frequency of deduction (e.g., Weekly, Biweekly, Monthly, Two months, Quarterly, Half annual, Yearly). Values in numbers are (7, 15, 30, 60, 90, 180, 360).
Name the subscription plan for identification purposes. The maximum number of characters is 200.
You need to enter the unique webhook URL in this parameter
Specify the number of days before which you want to send a notification to the customer to pay (currently supporting email notifications).
Define the days on which the subscription will be attempted again in case of a failure to collect the previous subscription amount.
The type of subscription plan. It accepts the values (rent) and the default is “rent.”
The number of deductions from this subscription. The default value is null.
Specify the subscription amount that will be charged.
If this flag is enabled, the system will use the first transaction amount instead of the specified subscription amount. Otherwise, it will use the subscription amount from the “Amount Cents”. Default value is false
Indicates whether the plan will be created, will be active, or will be paused. The default value is true.
MIGS Moto Integration ID, which will be used for upcoming transactions (recurring transactions).
Response
Response Attributes
Unique identifier for the transaction
Timestamp when the record was created
Timestamp when the record was last updated
Name of the item
Transaction amount in cents
Indicates if the subscription is active
What made this section unhelpful for you?
Base URL
Production:
Sandbox: