2013

Table Of Contents
Recurring Payments and Reference Transactions API Operations
SetCustomerBillingAgreement API Operation
12
166 February 01, 2013 Name-Value Pair API Developer Guide
SetCustomerBillingAgreement Response Message
SetCustomerBillingAgreement Response Fields
BILLINGTYPE Type of billing agreement for reference transactions. You must have permission from
PayPal to use this field.
For reference transactions, this field must be set to one of the following values:
MerchantInitiatedBilling - PayPal creates a billing agreement for each
transaction associated with buyer. You must specify version 54.0 or higher to use
this option.
MerchantInitiatedBillingSingleAgreement - PayPal creates a single
billing agreement for all transactions associated with buyer. Use this value unless
you need per-transaction billing agreements. You must specify version 58.0 or
higher to use this option.
Other defined values are not valid.
L_BILLINGAGREEMENTD
ESCRIPTION
n
Description of goods or services associated with the billing agreement. This field is
required for each recurring payment billing agreement. PayPal recommends that the
description contain a brief summary of the billing agreement terms and conditions.
For example, buyer is billed at “9.99 per month for 2 years”.
Character length and limitations: 127 single-byte alphanumeric characters
L_PAYMENTTYPE
n (Optional) Type of PayPal payment you require for the billing agreement. It is one of
the following values:
Any
InstantOnly
NOTE: For recurring payments, this field is ignored.
L_BILLINGAGREEMENTC
USTOM
n
(Optional) Custom annotation field for your own use.
NOTE: For recurring payments, this field is ignored.
Character length and limitations: 256 single-byte alphanumeric bytes
Field Description
TOKEN A unique time-stamped token, which uniquely identifies this transaction in
subsequent API calls.
NOTE: The token expires after 3 hours.
Character length and limitations: 20 single-byte characters
Field Description