You are here: API Foundations > Use Cases > Invoking the subscribe Call

Invoking the subscribe Call

For information on this topic, see subscribe. Essentially, first you populate all the data (account, contact, payment method, etc.), then you call subscribe.

Important!

Both the create and subscribe calls will create a new account; however, there are differences.

If you want to create an account without creating a subscription, use the create call. If you use create to create an account, you won't be able to create a subscription for that account.
If you want to create the account along with the subscription and the initial payment information, use the subscribe call.

To use the subscribe call,

Populate all the required fields for the Account object.
Populate all the required fields for the Contact object to be used as the BillTo.
Populate all the required fields for the Contact object to be used as the SoldTo. If this is not set,the BillTo will also be used as the SoldTo contact.
Populate all the required fields for the PaymentMethod object.
Populate all the required fields for the SubscriptionData object. This includes the following tasks:

Populate all the required fields for the Subscription object.
Populate all the required fields for the RatePlan object. Use a valid ID for ProductRatePlanId.
Populate all the required fields for the RatePlanCharge objects that needs to be updated for Name or Quantity. Use a valid ID for ProductRatePlanChargeId. If no RatePlanCharge objects are passed, the default RatePlanCharges will copied from the RatePlan object whose ID is passed in the RatePlan object in step b.

Create a SubscribeRequest object and set all the objects created in the previous steps.
Call the subscribe method, passing in the SubscribeRequest object and the SessionHeader object returned by the login call.
A SubscribeResponse object is returned. Get the SubscribeResult object from the returned response object and check for the value of the success field.

If the success value is true, read the other values returned in the SubscribeResult such as the AccountId, AccountNumber, SubscriptionId, SubscriptionNumber, InvoiceNumber, PaymentTransactionNumber.
If the success value is false, then process the Errors by getting the Code and Message from the Error objects.

Invoking the subscribe Call

See Also