BillingDetails Type

This type describes the billing arrangement.

Remarks

The Period and Frequency combine to define the billing cycle. TotalCycles is used to define how many billing cycles there will be. Other aspects of the billing arrangement are describes as well.

Example: Setting the fields:

  BillingDetails billingDetails = new BillingDetails()
  billingDetails.Period = BillingPeriods.bpMonth
  billingDetails.Frequency = "12"
  billingDetails.Amount = "12.01"
  billingDetails.StartDate = "2009-08-25T07:00:00Z"
  billingDetails.TotalCycles = "10"
  
  RecurringPayments1.BillingDetails = billingDetails

Fields

Amount
String

The amount to be billed for each billing cycle. This amount does not include shipping and tax amounts.

This value must not exceed $10,000 USD in any currency.

It will also not contain any currency symbols, must have two decimal places separated by a period (.), and optionally a comma (,) separating the thousands digits.

CurrencyCode
String

Type of currency in which you are accepting payments.

Three-character currency code for any of the supported PayPal currencies. Supported currencies may change over time, but at the time this writing the following currency codes are valid:


USD	US Dollars
CAD	Canadian Dollars
EUR	Euros
GBP	British Pounds
JPY	Japanese Yen
AUD	Australian Dollars

Frequency
String

The number of billing periods that make up one billing cycle.

The combination of Frequency and Period must be no more than one year. For example, if the Period is Week, then the Frequency must not be more than 52. Likewise, if the Period is Month, the Frequency must not be more than 12.

NOTE: If the Period has been set to SemiMonth, the Frequency must be 1.

Period
BillingPeriods

This field contains the unit for billing during the billing cycle.

Possible values include:


(0)	Day
(1)	Week
(2)	SemiMonth
(3)	Month
(4)	Year

If SemiMonth is specified, billing will be done on the first and fifteenth of each month.

ShippingAmount
String

The shipping amount associated with each billing cycle.

This value must not exceed $10,000 USD in any currency.

It will also not contain any currency symbols, must have two decimal places separated by a period (.), and optionally a comma (,) separating the thousands digits.

StartDate
String

Set this field to the date at which billing should begin for the current profile.

This property must be a valid date in UTC/GMT format.

NOTE: It may take up to 24 hours for the profile to be activated.

The date and time must be in the following format:

"yyyy-MM-ddTHH:mm:ss.fffZ".

This is explained in more detail below:


yyyy	Four-digit year, e.g. "2005"
MM	Two-digit month.
dd	Two-digit day.
T	Indicates time follows the date.
HH	Hours in military time (24-hour format).
mm	Minutes
ss	Seconds
fff	Milliseconds
Z	1-character (US military) representation of the time zone, "A" - "M" are negative offsets -1 to -12, with "J" not being used. "N" - "Y" are positive offsets 1 to 12, and "Z" indicates GMT/UTC (no offset).

For instance, "2004-05-26T15:00:00.000Z" is May 26th, 2004 at 3:00pm GMT.

TaxAmount
String

The tax amount associated with each billing cycle.

This value must not exceed $10,000 USD in any currency.

It will also not contain any currency symbols, must have two decimal places separated by a period (.), and optionally a comma (,) separating the thousands digits.

TotalCycles
String

The number of billing cycles for the payment period.

A billing cycle is specified by the combination of the Period and the Frequency fields. A billing cycle may not exceed one year.

If this property is not specified or set to zero, PayPal will continue billing this profile until it is cancelled or deactivated.

Constructors

[VB.NET]
Public BillingDetails()

[C#]
public BillingDetails();