Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Description

Length

subscription

Subscription identification

9

status

0 = Waiting for first payment
1 = Active
2 = Pending payment
3 = Inactive/Cancelled
4 = Expired
5 = Paused

1

frequency

Interval between the subscription renewals.

1

amount_brl

Amount in Brazilian Real of the recurring charge

7.2

number_recurrences

Number of recurrences existing in the subscription.

Unlimited

limit

Maximum subscription renewals (0 is unlimited).

3

view_future_charges

Number of the visible future charges

4

next_billing_date

Next billing date. Format: YYYY-MM-DD

10

cancellation_date

Date the subscription will be cancelled if not paid.
Format: YYYY-MM-DD

10

effective_cancellation_date

Date the subscription was effectively canceled.
Format: YYYY-MM-DD

10

order_token

Tokenized order number

80

customer_email

Customer's e-mail address

128

recurrences

JSON structure with the list of recurrences. See note "a"

products

JSON structure with the list of products or service set for the subscription. See note "b"

Unlimited

...