{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:paypal-subscriptions/plans-list":{"get":{"operationId":"payments_paypal_subscriptions_plans_list","summary":"List plans","description":"GET /v1/billing/plans","tags":["payments"],"parameters":[{"name":"Prefer","in":"query","required":false,"description":"The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response…","schema":{"type":"string","default":"return=minimal","description":"The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response…"}},{"name":"product_id","in":"query","required":false,"description":"Filters the response by a Product ID.","schema":{"type":"string","description":"Filters the response by a Product ID."}},{"name":"page_size","in":"query","required":false,"description":"The number of items to return in the response.","schema":{"type":"integer","default":10,"description":"The number of items to return in the response."}},{"name":"page","in":"query","required":false,"description":"A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and…","schema":{"type":"integer","default":1,"description":"A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and…"}},{"name":"total_required","in":"query","required":false,"description":"Indicates whether to show the total count in the response.","schema":{"type":"boolean","default":false,"description":"Indicates whether to show the total count in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-create":{"post":{"operationId":"payments_paypal_subscriptions_plans_create","summary":"Create plan","description":"POST /v1/billing/plans","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Prefer":{"type":"string","default":"return=minimal","description":"The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response…"},"PayPal-Request-Id":{"type":"string","description":"The server stores keys for 72 hours."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-get":{"get":{"operationId":"payments_paypal_subscriptions_plans_get","summary":"Show plan details","description":"GET /v1/billing/plans/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the subscription.","schema":{"type":"string","description":"The ID of the subscription."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-patch":{"post":{"operationId":"payments_paypal_subscriptions_plans_patch","summary":"Update plan","description":"PATCH /v1/billing/plans/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-activate":{"post":{"operationId":"payments_paypal_subscriptions_plans_activate","summary":"Activate plan","description":"POST /v1/billing/plans/{id}/activate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-deactivate":{"post":{"operationId":"payments_paypal_subscriptions_plans_deactivate","summary":"Deactivate plan","description":"POST /v1/billing/plans/{id}/deactivate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/plans-update-pricing-schemes":{"post":{"operationId":"payments_paypal_subscriptions_plans_update_pricing_schemes","summary":"Update pricing","description":"POST /v1/billing/plans/{id}/update-pricing-schemes","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-create":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_create","summary":"Create subscription","description":"POST /v1/billing/subscriptions","tags":["payments"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Prefer":{"type":"string","default":"return=minimal","description":"The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response…"},"PayPal-Request-Id":{"type":"string","description":"The server stores keys for 72 hours."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-get":{"get":{"operationId":"payments_paypal_subscriptions_subscriptions_get","summary":"Show subscription details","description":"GET /v1/billing/subscriptions/{id}","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the subscription.","schema":{"type":"string","description":"The ID of the subscription."}},{"name":"fields","in":"query","required":false,"description":"List of fields that are to be returned in the response. Possible value for fields are last_failed_payment and plan.","schema":{"type":"string","description":"List of fields that are to be returned in the response. Possible value for fields are last_failed_payment and plan."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-patch":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_patch","summary":"Update subscription","description":"PATCH /v1/billing/subscriptions/{id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-revise":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_revise","summary":"Revise plan or quantity of subscription","description":"POST /v1/billing/subscriptions/{id}/revise","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-suspend":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_suspend","summary":"Suspend subscription","description":"POST /v1/billing/subscriptions/{id}/suspend","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-cancel":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_cancel","summary":"Cancel subscription","description":"POST /v1/billing/subscriptions/{id}/cancel","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-activate":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_activate","summary":"Activate subscription","description":"POST /v1/billing/subscriptions/{id}/activate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-capture":{"post":{"operationId":"payments_paypal_subscriptions_subscriptions_capture","summary":"Capture authorized payment on subscription","description":"POST /v1/billing/subscriptions/{id}/capture","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"PayPal-Request-Id":{"type":"string","description":"The server stores keys for 72 hours."},"id":{"type":"string","description":"The ID of the subscription."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:paypal-subscriptions/subscriptions-transactions":{"get":{"operationId":"payments_paypal_subscriptions_subscriptions_transactions","summary":"List transactions for subscription","description":"GET /v1/billing/subscriptions/{id}/transactions","tags":["payments"],"parameters":[{"name":"id","in":"query","required":true,"description":"The ID of the subscription.","schema":{"type":"string","description":"The ID of the subscription."}},{"name":"start_time","in":"query","required":true,"description":"The start time of the range of transactions to list.","schema":{"type":"string","description":"The start time of the range of transactions to list."}},{"name":"end_time","in":"query","required":true,"description":"The end time of the range of transactions to list.","schema":{"type":"string","description":"The end time of the range of transactions to list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}