subscriptions library

You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see Subscriptions Overview.

https://developer.paypal.com/api/subscriptions/v1/

Classes

AmountWithBreakdown
The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.
ApplicationContext
The application context, which customizes the payer experience during the subscription approval process with PayPal.
BillingCycle
Billing cycle.
Card
A payment card.
CycleExecution
Trial and regular billing executions.
FailedPaymentDetails
Failed payment details.
Frequency
Frequency.
LastPaymentDetails
The details of the last payment.
PaymentMethod
PaymentPreferences
Payment preferences.
PaymentSource
A payment source
Plan
Billing plan.
PlanCollection
A collection of billing plans
PlanRequest
Billing plan.
PricingScheme
Pricing scheme.
PricingSchemesUpdateRequest
Updates pricing for a plan.
PricingSchemeUpdateRequest
A pricing scheme update request.
PricingTier
Pricing tier
Subscriber
A subscriber.
Subscription
A subscription.
SubscriptionBillingInfo
The subscriber billing information.
SubscriptionCaptureRequest
Capture authorized payment request
SubscriptionRequest
Create subscription request.
SubscriptionReviseRequest
Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount, shipping_address values for the subscription. This type of update requires the buyer's consent.
SubscriptionReviseResponse
The subscription revise response.
SubscriptionsApi
Subscriptions API interface
Taxes
Taxes.
Transaction
A transaction for a subscription
TransactionsList
List transactions response

Enums

CaptureStatus
The status of the captured payment.
CaptureType
The type of capture.
FailedPaymentReason
The reason code for the payment failure.
IntervalUnit
The interval at which the subscription is charged or billed.
PayeePreferred
The merchant-preferred payment methods.
PlanStatus
The plan status.
PricingModel
The pricing model.
SetupFeeFailureAction
The action to take on the subscription if the initial payment for the setup fails.
ShippingPreference
The location from which the shipping address is derived.
StandardEntryClassCode
NACHA (the regulatory body governing the ACH network) requires that API callers (merchants, partners) obtain the consumer’s explicit authorization before initiating a transaction. To stay compliant, you’ll need to make sure that you retain a compliant authorization for each transaction that you originate to the ACH Network using this API. ACH transactions are categorized (using SEC codes) by how you capture authorization from the Receiver (the person whose bank account is being debited or credited). PayPal supports the following SEC codes.
SubscriptionStatus
The status of the subscription.
TenureType
The tenure type of the billing cycle
UserAction
Configures the label name to Continue or Subscribe Now for subscription consent experience.