Skip to main content
POST
Create a recurrence plan

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
title
string

Title of the plan.

Example:

"Plano Premium Mensal"

description
string

Detailed description of the plan.

Example:

"Acesso completo a todas as funcionalidades da plataforma."

frequency
string

Billing frequency.

Example:

"MONTHLY"

period
integer

Period of the frequency (e.g., 1 for monthly, 3 for quarterly).

Example:

1

imediateAmount
number<float>

Immediate charge amount upon joining the plan.

Example:

49.9

recurrenceAmount
number<float>

Amount for recurring charges.

Example:

29.9

minimumRecurrenceAmount
number<float>

Minimum amount accepted for recurring charges.

Example:

29.9

retryPolicy
enum<string>

Retry policy in case of failure.

Available options:
ACCEPT_3R_7D,
NOT_ACCEPT
Example:

"ACCEPT_3R_7D"

enabled
boolean

Indicates if the plan is active.

Example:

true

Response

Plan created successfully.

status
integer
Example:

0

message
string
Example:

"success"

id
string

Unique ID of the generated plan.

Example:

"6851c0842bf40769ead1fde5"

title
string
Example:

"Plano Premium Mensal"

description
string
Example:

"Acesso completo a todas as funcionalidades da plataforma."

frequency
string
Example:

"MONTHLY"

period
integer
Example:

1

imediateAmount
number
Example:

49.9

recurrenceAmount
number
Example:

29.9

minimumRecurrenceAmount
number
Example:

29.9

retryPolicy
string
Example:

"ACCEPT_3R_7D"

enabled
boolean
Example:

true

creation
string<date-time>

Date and time of plan creation.

Example:

"2025-06-17 19:22:44"