3. Creating a subscription

3.1. Sending the request

Your POST must be sent to https://sandbox.pagbrasil.com/api/pagstream/subscription/add setting the content-type of the request header and body as "x-www-form-urlencoded".

Please note that this URL shall only be used for integration and testing procedures. Once the Payment Service Agreement is signed, you will receive the production environment's URL when you request your account to go live.

Request parameters:

Field	Description	Required	Length

Field	Description	Required	Length
secret	Secret phrase as defined in the PagBrasil Dashboard	Yes	128
pbtoken	Token assigned to your merchant account. Your token is displayed at the PagBrasil Dashboard, menu Account > Settings.	Yes	32
products	JSON structure with the list of products or service in the subscription. See note “h“	Yes	Unlimited
product_name	Product name. See note "c"	Yes	254
customer_name	Customer's full name if an individual, or "razão social" if the customer is a company. See note "d"	Yes	128
customer_taxid	CPF if an individual, or CNPJ if the customer is a company. See note "e"	Yes	14
customer_email	Customer's e-mail address	Yes	128
customer_phone	Customer's phone number (including the 2-digit area code)	Yes	40
address_street	Customer's street address	Yes	200
address_zip	Customer's postal code (in Brazil called CEP). Only digits, do not include the dash.	Yes	8
address_city	Customer's city	Yes	40
address_state	Customer's state. See note "f"	Yes	2
amount_brl	Amount in Brazilian Real of the recurring charge.	Yes	7.2
limit	Maximum subscription renewals (0 or empty is unlimited).	No	3
next_billing_date	Start date for the first recurring charge. Format: YYYY-MM-DD	Yes	10
billing_cycle	Interval between the subscription renewals. Customized intervals may be defined at the PagBrasil Dashboard. Pre-defined intervals: W = Weekly M = Monthly Q = Quaterly S = Semiannually Y = Yearly	Yes	16
shipping_cycle	Interval between deliveries. Custom intervals can be set in the PagBrasil Dashboard.	No	16
response_type	XML (default) or JSON.	No	4
cc_installments	Number of installments (1 to 12). See note "g".	No*	2
cc_holder	Credit card holder's name	No*	30
cc_number	Credit card number	No*	14 - 19
cc_expiration	Credit card expiration date. Format: MM/YY.	No*	5
cc_cvv	Card verification value (security code).	No*	3 - 4
pix_rec_id	Automatic Pix recurrence identifier.	No	64

Notes:

a) All fields are required except when noted otherwise.

b) If a parameter is sent with a size greater than the maximum allowed, process will not be aborted but the value will be truncated.

c) The parameter product_name must contain the name of the product or service purchased, and it is required for compliance purposes.

d) You need to let the customer selects if they are a "pessoa física" (individual) or a "pessoa jurídica" (company). If they select "pessoa física", you need to ask for their full name and CPF (see note "h"). If they select "pessoa jurídica", you need to ask for the "razão social" (official company name registered at the local tax authority) and CNPJ (see note "e").