Create Subscription Item

POST {{baseUrl}}/v1/subscription_items

Create a subscription item and add it to an existing subscription for recurring payment.

Request Body

{"plan"=>"<string>", "subscription"=>"<string>", "prorate"=>"<boolean>", "proration_date"=>"<number>", "quantity"=>"<number>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:{&quot;created&quot;:&quot;\u003cnumber\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{},&quot;plan&quot;:{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;aggregate_usage&quot;:&quot;sum&quot;,&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;billing_scheme&quot;:&quot;per_unit&quot;,&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;/AED&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;interval&quot;:&quot;week&quot;,&quot;interval_count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;metadata&quot;:{},&quot;nickname&quot;:&quot;\u003cstring\u003e&quot;,&quot;product&quot;:{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;attributes&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;images&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;metadata&quot;:{},&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;package_dimensions&quot;:{&quot;height&quot;:&quot;\u003cnumber\u003e&quot;,&quot;length&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;width&quot;:&quot;\u003cnumber\u003e&quot;},&quot;shippable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;skus&quot;:[{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;attributes&quot;:{},&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;PLN&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;image&quot;:&quot;\u003cstring\u003e&quot;,&quot;inventory&quot;:{},&quot;metadata&quot;:{},&quot;package_dimensions&quot;:{&quot;height&quot;:&quot;\u003cnumber\u003e&quot;,&quot;length&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;width&quot;:&quot;\u003cnumber\u003e&quot;},&quot;price&quot;:&quot;\u003cnumber\u003e&quot;,&quot;product&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;attributes&quot;:{},&quot;created_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;ARS&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;image&quot;:&quot;\u003cstring\u003e&quot;,&quot;inventory&quot;:{},&quot;metadata&quot;:{},&quot;package_dimensions&quot;:{&quot;height&quot;:&quot;\u003cnumber\u003e&quot;,&quot;length&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;width&quot;:&quot;\u003cnumber\u003e&quot;},&quot;price&quot;:&quot;\u003cnumber\u003e&quot;,&quot;product&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cnumber\u003e&quot;}],&quot;statement_descriptor&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;services&quot;,&quot;unit_label&quot;:&quot;\u003cstring\u003e&quot;,&quot;updated_at&quot;:&quot;\u003cnumber\u003e&quot;},&quot;tiers&quot;:[{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;flat_amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;up_to&quot;:&quot;\u003cstring\u003e&quot;},{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;flat_amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;up_to&quot;:&quot;\u003cstring\u003e&quot;}],&quot;tiers_mode&quot;:&quot;graduated&quot;,&quot;transform_usage&quot;:{&quot;divide_by&quot;:&quot;\u003cnumber\u003e&quot;,&quot;round&quot;:&quot;\u003cstring\u003e&quot;},&quot;trial_period_days&quot;:&quot;\u003cnumber\u003e&quot;,&quot;usage_type&quot;:&quot;licensed&quot;},&quot;quantity&quot;:&quot;\u003cnumber\u003e&quot;,&quot;subscription_id&quot;:&quot;\u003cstring\u003e&quot;},&quot;status&quot;:{&quot;error_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;message&quot;:&quot;\u003cstring\u003e&quot;,&quot;operation_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;response_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}}