Headers
Example:
"your-x-api-key"
Example:
"your-x-api-token"
Body
application/json
Title of the plan.
Example:
"Plano Premium Mensal"
Detailed description of the plan.
Example:
"Acesso completo a todas as funcionalidades da plataforma."
Billing frequency.
Example:
"MONTHLY"
Period of the frequency (e.g., 1 for monthly, 3 for quarterly).
Example:
1
Immediate charge amount upon joining the plan.
Example:
49.9
Amount for recurring charges.
Example:
29.9
Minimum amount accepted for recurring charges.
Example:
29.9
Retry policy in case of failure.
Available options:
ACCEPT_3R_7D, NOT_ACCEPT Example:
"ACCEPT_3R_7D"
Indicates if the plan is active.
Example:
true
Response
Plan created successfully.
Example:
0
Example:
"success"
Unique ID of the generated plan.
Example:
"6851c0842bf40769ead1fde5"
Example:
"Plano Premium Mensal"
Example:
"Acesso completo a todas as funcionalidades da plataforma."
Example:
"MONTHLY"
Example:
1
Example:
49.9
Example:
29.9
Example:
29.9
Example:
"ACCEPT_3R_7D"
Example:
true
Date and time of plan creation.
Example:
"2025-06-17 19:22:44"