Skip to content

Latest commit

 

History

History
175 lines (154 loc) · 4.48 KB

addon.md

File metadata and controls

175 lines (154 loc) · 4.48 KB
Raw

Addons

Create an addon

instance.subscriptions.createAddon('sub_I55auG9GnbsR8u',{
  "item":{
    "name":"Extra appala (papadum)",
    "amount":30000,
    "currency":"INR",
    "description":"1 extra oil fried appala with meals"
  },
  "quantity":2
})

Parameters:

Name Type Description
subscriptionId* boolean The subscription ID to which the add-on is being added.
items array All parameters listed here are supported
quantity integer This specifies the number of units of the add-on to be charged to the customer.

Response:

{
  "id":"ao_00000000000001",
  "entity":"addon",
  "item":{
    "id":"item_00000000000001",
    "active":true,
    "name":"Extra appala (papadum)",
    "description":"1 extra oil fried appala with meals",
    "amount":30000,
    "unit_amount":30000,
    "currency":"INR",
    "type":"addon",
    "unit":null,
    "tax_inclusive":false,
    "hsn_code":null,
    "sac_code":null,
    "tax_rate":null,
    "tax_id":null,
    "tax_group_id":null,
    "created_at":1581597318,
    "updated_at":1581597318
  },
  "quantity":2,
  "created_at":1581597318,
  "subscription_id":"sub_00000000000001",
  "invoice_id":null
}

Fetch all addons

instance.addons.all(options)

Parameters:

Name Type Description
from timestamp timestamp after which the addons were created
to timestamp timestamp before which the addons were created
count integer number of addons to fetch (default: 10)
skip integer number of addons to be skipped (default: 0)

Response:

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "ao_00000000000002",
      "entity": "addon",
      "item": {
        "id": "item_00000000000002",
        "active": true,
        "name": "Extra sweet",
        "description": "1 extra sweet of the day with meals",
        "amount": 90000,
        "unit_amount": 90000,
        "currency": "INR",
        "type": "addon",
        "unit": null,
        "tax_inclusive": false,
        "hsn_code": null,
        "sac_code": null,
        "tax_rate": null,
        "tax_id": null,
        "tax_group_id": null,
        "created_at": 1581597318,
        "updated_at": 1581597318
      },
      "quantity": 1,
      "created_at": 1581597318,
      "subscription_id": "sub_00000000000001",
      "invoice_id": "inv_00000000000001"
    }
  ]
}

Fetch an addon

instance.addons.fetch(addonId)

Parameters:

Name Type Description
addonId* string addon id to be fetched

Response:

{
  "id":"ao_00000000000001",
  "entity":"addon",
  "item":{
    "id":"item_00000000000001",
    "active":true,
    "name":"Extra appala (papadum)",
    "description":"1 extra oil fried appala with meals",
    "amount":30000,
    "unit_amount":30000,
    "currency":"INR",
    "type":"addon",
    "unit":null,
    "tax_inclusive":false,
    "hsn_code":null,
    "sac_code":null,
    "tax_rate":null,
    "tax_id":null,
    "tax_group_id":null,
    "created_at":1581597318,
    "updated_at":1581597318
  },
  "quantity":2,
  "created_at":1581597318,
  "subscription_id":"sub_00000000000001",
  "invoice_id":null
}

Delete an addon

instance.addons.delete(addonId)

Parameters:

Name Type Description
addonId* string addon id to be deleted

Response:

[]

PN: * indicates mandatory fields

For reference click here