Qodex.ai

Create plan

POST {{base_url}}/v1/billing/plans

Creates a plan that defines pricing and billing cycle details for subscriptions.

Request Body

{"product_id"=>"{{product_id}}", "name"=>"Fresh Clean Tees Plan", "description"=>"Each shirt they send out to subscribers is designed with lots of attention to detail", "status"=>"ACTIVE", "billing_cycles"=>[{"frequency"=>{"interval_unit"=>"MONTH", "interval_count"=>1}, "tenure_type"=>"TRIAL", "sequence"=>1, "total_cycles"=>1, "pricing_scheme"=>{"fixed_price"=>{"value"=>"1", "currency_code"=>"USD"}}}, {"frequency"=>{"interval_unit"=>"MONTH", "interval_count"=>1}, "tenure_type"=>"REGULAR", "sequence"=>2, "total_cycles"=>12, "pricing_scheme"=>{"fixed_price"=>{"value"=>"44", "currency_code"=>"USD"}}}], "payment_preferences"=>{"auto_bill_outstanding"=>true, "setup_fee"=>{"value"=>"10", "currency_code"=>"USD"}, "setup_fee_failure_action"=>"CONTINUE", "payment_failure_threshold"=>3}, "taxes"=>{"percentage"=>"10", "inclusive"=>false}}

HEADERS

| Key | Datatype | Required | Description | | Content-Type | string | | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | | PayPal-Request-Id | string | | The server stores keys for 72 hours. | | PayPal-Client-Metadata-Id | string | | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | | PayPal-Partner-Attribution-Id | string | | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | | PayPal-Auth-Assertion | string | | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | | Prefer | string | | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |

RESPONSES

status: Created

{&quot;id&quot;:&quot;P-38409749PP8329921MIBOOGA&quot;,&quot;product_id&quot;:&quot;1644357377&quot;,&quot;name&quot;:&quot;Fresh Clean Tees Plan&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;description&quot;:&quot;Each shirt they send out to subscribers is designed with lots of attention to detail&quot;,&quot;usage_type&quot;:&quot;LICENSED&quot;,&quot;billing_cycles&quot;:[{&quot;pricing_scheme&quot;:{&quot;version&quot;:1,&quot;fixed_price&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;1.0&quot;},&quot;create_time&quot;:&quot;2022-02-08T21:56:40Z&quot;,&quot;update_time&quot;:&quot;2022-02-08T21:56:40Z&quot;},&quot;frequency&quot;:{&quot;interval_unit&quot;:&quot;MONTH&quot;,&quot;interval_count&quot;:1},&quot;tenure_type&quot;:&quot;TRIAL&quot;,&quot;sequence&quot;:1,&quot;total_cycles&quot;:1},{&quot;pricing_scheme&quot;:{&quot;version&quot;:1,&quot;fixed_price&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;44.0&quot;},&quot;create_time&quot;:&quot;2022-02-08T21:56:40Z&quot;,&quot;update_time&quot;:&quot;2022-02-08T21:56:40Z&quot;},&quot;frequency&quot;:{&quot;interval_unit&quot;:&quot;MONTH&quot;,&quot;interval_count&quot;:1},&quot;tenure_type&quot;:&quot;REGULAR&quot;,&quot;sequence&quot;:2,&quot;total_cycles&quot;:12}],&quot;payment_preferences&quot;:{&quot;service_type&quot;:&quot;PREPAID&quot;,&quot;auto_bill_outstanding&quot;:true,&quot;setup_fee&quot;:{&quot;currency_code&quot;:&quot;USD&quot;,&quot;value&quot;:&quot;10.0&quot;},&quot;setup_fee_failure_action&quot;:&quot;CONTINUE&quot;,&quot;payment_failure_threshold&quot;:3},&quot;taxes&quot;:{&quot;percentage&quot;:&quot;10.0&quot;,&quot;inclusive&quot;:false},&quot;quantity_supported&quot;:false,&quot;create_time&quot;:&quot;2022-02-08T21:56:40Z&quot;,&quot;update_time&quot;:&quot;2022-02-08T21:56:40Z&quot;,&quot;links&quot;:[{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/plans/P-38409749PP8329921MIBOOGA&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;GET&quot;,&quot;encType&quot;:&quot;application/json&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/plans/P-38409749PP8329921MIBOOGA&quot;,&quot;rel&quot;:&quot;edit&quot;,&quot;method&quot;:&quot;PATCH&quot;,&quot;encType&quot;:&quot;application/json&quot;},{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/billing/plans/P-38409749PP8329921MIBOOGA/deactivate&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;POST&quot;,&quot;encType&quot;:&quot;application/json&quot;}]}