Subscribe API

The following table lists and summarizes the Subscribe API objects in SOAP.

Subscribe API Object	Description
`Account`	All the customer information.
`Activity`	Records non purchase related activity on your site.
`Address`	Records a customer’s address.
`AutoBill`	Describes the subscription terms, the customer’s relationship to a product/service and a Billing Plan.
`BillingPlan`	Describes billing scheduling and frequency, which defines how charges are made over time.
`Campaign`	Describes the parameters of a discount Campaign.
`Chargeback`	Details the chargeback information for a customer account. (Works in conjunction with ChargeGuard.)
`Entitlement`	Details the status of a customer’s current access (entitlement) to your product/service.
`GiftCard`	Describes details of a gift card redeemed or to be redeemed through Subscribe.
`NameValuePair`	Referenced by several Subscribe objects, the `NameValuePair` object is used to hold additional attributes not otherwise supported in the object.
`PaymentMethod`	Details a customer’s payment method, such as Credit Card, PayPal, or Direct Debit.
`PaymentProvider`	Serves as a wrapper to contain static information required by a payment provider for payment processing.
`Product`	Describes a product or service that you offer.
`RatePlan`	Defines the logic by which the pricing structure for Rated Products will be determined.
`Refund`	Describes a refund on a transaction or account.
`SeasonSet`	Defines a group of time intervals, which may be used with Billing Plans to define both Billing Cycles, and Entitlement grants.
`Token`	Describes a customer account’s non-currency balance, such as virtual currency, frequent flier miles, downloads, or storage space.
`Transaction`	Handles the transactions, generated through Subscribe, that relate to a customer account. (With ChargeGuard integration, be certain to report transactions to Vindicia.)
`WebSession`	Tracks your Web order form’s submission activity in the context of the Hosted Order Automation (HOA) capacity.

The Subscribe API Guide describes the objects in detail. These objects include data members, and methods that operate on the data members. Write to the Subscribe API with PHP, Perl, Java, .NET with C#, or C++ by using the Subscribe client libraries. You may also implement a native library for other environments with the Subscribe Web Services Description Language (WSDL) files. Note: Because Vindicia supports multiple programming languages, the descriptions and examples of the Subscribe objects, data members, and methods are in generic pseudo-code. Translate this pseudo-code to your programming language of choice. Parent topic:Subscribe Client Library Setup

Home

Guides

APIs