Enable Subscribers to Purchase a Subscription at a Promotional Rate

You can configure the Subscribe APIs to allow your subscribers to purchase a subscription at a promotional rate.

• Use Case Number: 2-2-04
• Completed By: Software Developer
• **Estimated Completion Time:**1 day

​

Basic Scenario

A new subscriber purchases a Subscription using a promotion code to access a promotional rate.

​

Design Approach

While this use case is similar to the basic use case for creating subscriptions (Enable Subscribers to Purchase a Subscription With a Credit Card), it has a slight modification in that you must pass a Campaign Code that references a Promotion style Campaign. The following diagram illustrates the use case sequence.

• Configure a Promotion Style Campaign Using Subscribe APIs

Parent topic:Campaigns & Promotions

​

Configure a Promotion Style Campaign Using Subscribe APIs

Set Up Promotional Pricing using the Subscribe Portal. (See Set Up Promotional Pricing.)

1. Call the subscriptions endpoint passing the promotion style campaign code that were created using the Subscribe Portal. Sample Code Endpoint: https://api.staging.us-west.vindicia.com/subscriptions?dryrun=0 JSON Request:
   
   {
     "billing_plan": {
       "id": "MONTHLY"
     },
     "account": {
       "email_type": "html",
       "language": "EN",
       "id": "jZ9oEKQNiVGheLSn",
       "shipping_address": {
         "city": "Pleasant Prairie",
         "name": "Queen Olsteen",
         "district": "WI",
         "country": "US",
         "line1": "15425 County Road 47",
         "postal_code": "53158"
       },
       "default_currency": "USD",
       "email": "foo@foo.com",
       "name": "Queen Olsteen"
     },
     "description": "Subscription_jZ9oEKQNiVGheLSn",
     "policy": {
       "ignore_avs_policy": 1,
       "validate_for_future_payment": 0,
       "ignore_cvn_policy": 1,
       "immediate_auth_failure_policy": "doNotSaveAutoBill",
       "min_chargeback_probability": 99
     },
     "currency": "USD",
     "payment_method": {
       "billing_address": {
         "city": "Pleasant Prairie",
         "name": "Queen Olsteen",
         "district": "WI",
         "country": "US",
         "line1": "15425 County Road 47",
         "postal_code": "53158"
       },
       "account_holder": "Queen Olsteen",
       "credit_card": {
         "expiration_date": "202003",
         "account": "4113900000000007"
       },
       "customer_description": "Credit Card",
       "active": 1,
       "type": "CreditCard",
       "id": "CC_jZ9oEKQNiVGheLSn"
     },
     "items": [
       {
         "product": {
           "id": "Generic"
         },
         "id": "Item_jZ9oEKQNiVGheLSn_1",
         "campaign_code": "PROMO-CODE-10Px12"
       }
     ],
     "id": "Subscription_jZ9oEKQNiVGheLSn",
     "minimum_commitment": 0
   }
   

• A Proper Subscription with Account and Payment Method objects is created in Subscribe.
• Initial Transaction is generated if applicable, including any applicable taxation.
• Future billings are correctly predicted.
• The Account has been granted appropriate Entitlements.
• The promotional rate is applied in current and future transactions, if applicable.

Parent topic:Enable Subscribers to Purchase a Subscription at a Promotional Rate