{"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:billsby/customer-list-customers":{"get":{"operationId":"payments_billsby_customer_list_customers","summary":"List customers","description":"GET /{companyDomain}/customers","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"page","in":"query","required":true,"description":"The page of customers you would like to view","schema":{"type":"integer","description":"The page of customers you would like to view"}},{"name":"pageSize","in":"query","required":true,"description":"The number of records to return per page (max 100)","schema":{"type":"integer","description":"The number of records to return per page (max 100)"}},{"name":"search","in":"query","required":false,"description":"Filter customers by name (this can be a partial name)","schema":{"type":"string","description":"Filter customers by name (this can be a partial name)"}}],"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:billsby/customer-create-without-subscription":{"post":{"operationId":"payments_billsby_customer_create_without_subscription","summary":"Create without subscription","description":"POST /{companyDomain}/customers","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"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:billsby/customer-get-details":{"get":{"operationId":"payments_billsby_customer_get_details","summary":"Customer details","description":"GET /{companyDomain}/customers/{customerUniqueId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/customer-update-details":{"post":{"operationId":"payments_billsby_customer_update_details","summary":"Update customer","description":"PUT /{companyDomain}/customers/{customerUniqueId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"},"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:billsby/customer-delete-by-id":{"post":{"operationId":"payments_billsby_customer_delete_by_id","summary":"Delete a customer","description":"DELETE /{companyDomain}/customers/{customerUniqueId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}}}}},"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:billsby/customer-get-subscriptions-by-unique-id":{"get":{"operationId":"payments_billsby_customer_get_subscriptions_by_unique_id","summary":"Customer subscriptions","description":"GET /{companyDomain}/customers/{customerUniqueId}/subscriptions","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/customer-add-subscription-to-existing-customer":{"post":{"operationId":"payments_billsby_customer_add_subscription_to_existing_customer","summary":"Add subscription to existing customer","description":"POST /{companyDomain}/customers/{customerUniqueId}/subscriptions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"},"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:billsby/customer-get-feature-tags":{"get":{"operationId":"payments_billsby_customer_get_feature_tags","summary":"Customer feature tags","description":"GET /{companyDomain}/customers/{customerUniqueId}/subscriptions/featuretags","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/invoice-get-payment-logs":{"get":{"operationId":"payments_billsby_invoice_get_payment_logs","summary":"Customer payment logs","description":"GET /{companyDomain}/customers/{customerUniqueId}/invoices/{invoiceNumber}/paymentlogs","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}},{"name":"invoiceNumber","in":"query","required":true,"description":"The unique identifier of the invoice in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the invoice in the Billsby platform"}}],"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:billsby/customer-update-payment-details-request":{"get":{"operationId":"payments_billsby_customer_update_payment_details_request","summary":"Request to update payment details","description":"GET /{companyDomain}/customers/{customerUniqueId}/paymentdetailsrequest","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/customer-update-payment-card-token":{"post":{"operationId":"payments_billsby_customer_update_payment_card_token","summary":"Update payment card token","description":"PUT /{companyDomain}/customers/{customerUniqueId}/paymentCard","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"},"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:billsby/invoice-get-customer-invoices":{"get":{"operationId":"payments_billsby_invoice_get_customer_invoices","summary":"Customer invoices","description":"GET /{companyDomain}/customers/{customerUniqueId}/invoices","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/invoice-create-one-time-charge":{"post":{"operationId":"payments_billsby_invoice_create_one_time_charge","summary":"Create a one-time charge","description":"POST /{companyDomain}/customers/{customerUniqueId}/invoices","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"},"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:billsby/customer-clear-gdpr-data":{"post":{"operationId":"payments_billsby_customer_clear_gdpr_data","summary":"Clear customer data (GDPR)","description":"PUT /{companyDomain}/customers/{customerUniqueId}/gdprcleanup","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}}}}},"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:billsby/subscription-list-subscriptions":{"get":{"operationId":"payments_billsby_subscription_list_subscriptions","summary":"List subscriptions","description":"GET /{companyDomain}/subscriptions","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"page","in":"query","required":true,"description":"The page of customers you would like to view","schema":{"type":"integer","description":"The page of customers you would like to view"}},{"name":"pageSize","in":"query","required":true,"description":"The number of records to return per page","schema":{"type":"integer","description":"The number of records to return per page"}},{"name":"orderBy","in":"query","required":false,"description":"You can order the subscriptions by any of the subscription object properties (e.g. CreatedOn to sort by date of creation)","schema":{"type":"string","description":"You can order the subscriptions by any of the subscription object properties (e.g. CreatedOn to sort by date of creation)"}},{"name":"orderByDescending","in":"query","required":false,"description":"The ordering direction of the previously set property (e.g. Descending in CreatedOn will sort from newest to oldest, non-descending from…","schema":{"type":"string","description":"The ordering direction of the previously set property (e.g. Descending in CreatedOn will sort from newest to oldest, non-descending from…"}},{"name":"isActive","in":"query","required":false,"description":"Will show only the subscriptions that are active","schema":{"type":"boolean","description":"Will show only the subscriptions that are active"}},{"name":"isInFreeTrial","in":"query","required":false,"description":"Will show only the subscriptions that are in free trial","schema":{"type":"boolean","description":"Will show only the subscriptions that are in free trial"}},{"name":"productName","in":"query","required":false,"description":"Will show only the subscriptions that has products whose names matches the value provided here","schema":{"type":"string","description":"Will show only the subscriptions that has products whose names matches the value provided here"}},{"name":"planName","in":"query","required":false,"description":"Will show only the subscriptions that has plans whose names matches the value provided here","schema":{"type":"string","description":"Will show only the subscriptions that has plans whose names matches the value provided here"}}],"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:billsby/customer-create-new-customer-and-subscription":{"post":{"operationId":"payments_billsby_customer_create_new_customer_and_subscription","summary":"Create new customer and subscription","description":"POST /{companyDomain}/subscriptions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"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:billsby/subscription-get-details":{"get":{"operationId":"payments_billsby_subscription_get_details","summary":"Subscription details","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/subscription-cancel-subscription":{"post":{"operationId":"payments_billsby_subscription_cancel_subscription","summary":"Cancel a subscription","description":"DELETE /{companyDomain}/subscriptions/{subscriptionUniqueId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","subscriptionUniqueId","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"subscriptionUniqueId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}}}}},"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:billsby/subscription-get-shipping-address":{"get":{"operationId":"payments_billsby_subscription_get_shipping_address","summary":"Shipping address","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/shippingAddress","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/subscription-update-shipping-address":{"post":{"operationId":"payments_billsby_subscription_update_shipping_address","summary":"Update subscription shipping address","description":"PUT /{companyDomain}/subscriptions/{subscriptionUniqueId}/shippingAddress","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","subscriptionUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"subscriptionUniqueId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"},"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:billsby/subscription-list-tags-by-subscription":{"get":{"operationId":"payments_billsby_subscription_list_tags_by_subscription","summary":"Feature tags by Subscription","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/tags","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/subscription-feature-tags-split":{"get":{"operationId":"payments_billsby_subscription_feature_tags_split","summary":"Feature tags by plan and custom tags","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/tags/split","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/subscription-get-event-logs":{"get":{"operationId":"payments_billsby_subscription_get_event_logs","summary":"Event logs","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/logs","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}},{"name":"page","in":"query","required":true,"description":"The page of customers you would like to view","schema":{"type":"integer","description":"The page of customers you would like to view"}},{"name":"pageSize","in":"query","required":true,"description":"The number of records to return per page (max 100)","schema":{"type":"integer","description":"The number of records to return per page (max 100)"}}],"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:billsby/subscription-add-feature-tags":{"post":{"operationId":"payments_billsby_subscription_add_feature_tags","summary":"Add feature tags","description":"POST /{companyDomain}/subscriptions/tags","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"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:billsby/subscription-change-plan":{"post":{"operationId":"payments_billsby_subscription_change_plan","summary":"Change plan","description":"PUT /{companyDomain}/subscriptions/{subscriptionUniqueId}/plan","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","subscriptionUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"subscriptionUniqueId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"},"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:billsby/subscription-remove-feature-tag":{"post":{"operationId":"payments_billsby_subscription_remove_feature_tag","summary":"Delete feature tag","description":"DELETE /{companyDomain}/subscriptions/tags/{tagname}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","tagname"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"tagname":{"type":"string","description":"The name of the custom feature tag you would like to delete"},"subsId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}}}}},"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:billsby/subscription-update-renewal-date":{"post":{"operationId":"payments_billsby_subscription_update_renewal_date","summary":"Update next renewal date","description":"PUT /{companyDomain}/subscriptions/{subscriptionUniqueId}/renewaldate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","subscriptionUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"subscriptionUniqueId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"},"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:billsby/invoice-details":{"get":{"operationId":"payments_billsby_invoice_details","summary":"Individual invoices","description":"GET /invoices/{invoiceNumber}","tags":["payments"],"parameters":[{"name":"invoiceNumber","in":"query","required":true,"description":"The invoice number for the invoice you'd like to retrieve","schema":{"type":"string","description":"The invoice number for the invoice you'd like to retrieve"}}],"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:billsby/invoice-list-company-invoices":{"get":{"operationId":"payments_billsby_invoice_list_company_invoices","summary":"Company invoices","description":"GET /{companyDomain}/companies/invoices","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"page","in":"query","required":true,"description":"The page of invoices you would like to view","schema":{"type":"integer","description":"The page of invoices you would like to view"}},{"name":"pageSize","in":"query","required":true,"description":"The number of records to return per page (max 100)","schema":{"type":"integer","description":"The number of records to return per page (max 100)"}},{"name":"query","in":"query","required":false,"description":"Add search terms here to filter results","schema":{"type":"string","description":"Add search terms here to filter results"}},{"name":"orderBy","in":"query","required":false,"description":"Sort the results by particular properties","schema":{"type":"string","description":"Sort the results by particular properties"}},{"name":"orderByDescending","in":"query","required":false,"description":"Sort the results by particular properties in descending order","schema":{"type":"string","description":"Sort the results by particular properties in descending order"}},{"name":"isPending","in":"query","required":false,"description":"Do you want to show invoices with the status 'pending'; true or false","schema":{"type":"boolean","description":"Do you want to show invoices with the status 'pending'; true or false"}},{"name":"isPaid","in":"query","required":false,"description":"Do you want to show invoices with the status 'paid'; true or false","schema":{"type":"boolean","description":"Do you want to show invoices with the status 'paid'; true or false"}},{"name":"isUnpaid","in":"query","required":false,"description":"Do you want to show invoices with the status 'unpaid'; true or false","schema":{"type":"string","description":"Do you want to show invoices with the status 'unpaid'; true or false"}},{"name":"isPaidOffline","in":"query","required":false,"description":"Do you want to show invoices with the status 'paid offline'; true or false","schema":{"type":"boolean","description":"Do you want to show invoices with the status 'paid offline'; true or false"}},{"name":"isWrittenOff","in":"query","required":false,"description":"Do you want to show invoices with the status 'written off'; true or false","schema":{"type":"boolean","description":"Do you want to show invoices with the status 'written off'; true or false"}}],"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:billsby/invoice-create-refund":{"post":{"operationId":"payments_billsby_invoice_create_refund","summary":"Refund an invoice","description":"POST /{companyDomain}/customers/{customerUniqueId}/refunds","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customerUniqueId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customerUniqueId":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"},"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:billsby/invoice-reattempt-payment":{"post":{"operationId":"payments_billsby_invoice_reattempt_payment","summary":"Reattempt invoice payment","description":"PUT /{companyDomain}/invoices/{invoiceNumber}/Payment","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceNumber","companyDomain"],"properties":{"invoiceNumber":{"type":"string","description":"The unique identifier of the invoice in the Billsby platform"},"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}}}}},"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:billsby/invoice-mark-as-paid-offline":{"post":{"operationId":"payments_billsby_invoice_mark_as_paid_offline","summary":"Invoice paid offline","description":"PUT /{companyDomain}/invoices/{invoiceNumber}/PaidOffline","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceNumber","companyDomain"],"properties":{"invoiceNumber":{"type":"string","description":"The unique identifier of the invoice in the Billsby platform"},"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}}}}},"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:billsby/invoice-mark-written-off":{"post":{"operationId":"payments_billsby_invoice_mark_written_off","summary":"Invoice written off","description":"PUT /{companyDomain}/invoices/{invoiceNumber}/WrittenOff","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceNumber","companyDomain"],"properties":{"invoiceNumber":{"type":"string","description":"The unique identifier of the invoice in the Billsby platform"},"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}}}}},"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:billsby/creditnote-list":{"get":{"operationId":"payments_billsby_creditnote_list","summary":"Company credit notes","description":"GET /{companyDomain}/companies/creditnotes","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"page","in":"query","required":true,"description":"The page of credit notes you would like to view","schema":{"type":"integer","description":"The page of credit notes you would like to view"}},{"name":"pageSize","in":"query","required":true,"description":"The number of records to return per page (max 100)","schema":{"type":"integer","description":"The number of records to return per page (max 100)"}},{"name":"query","in":"query","required":false,"description":"Add search terms here to filter results","schema":{"type":"string","description":"Add search terms here to filter results"}},{"name":"orderBy","in":"query","required":false,"description":"Sort the results by particular properties","schema":{"type":"string","description":"Sort the results by particular properties"}},{"name":"orderByDescending","in":"query","required":false,"description":"Sort the results by particular properties in descending order","schema":{"type":"string","description":"Sort the results by particular properties in descending order"}},{"name":"isPending","in":"query","required":false,"description":"Do you want to show credit notes with the status 'pending'; true or false","schema":{"type":"boolean","description":"Do you want to show credit notes with the status 'pending'; true or false"}},{"name":"isPaid","in":"query","required":false,"description":"Do you want to show credit notes with the status 'paid'; true or false","schema":{"type":"boolean","description":"Do you want to show credit notes with the status 'paid'; true or false"}},{"name":"isFailed","in":"query","required":false,"description":"Do you want to show credit notes with the status 'failed'; true or false","schema":{"type":"boolean","description":"Do you want to show credit notes with the status 'failed'; true or false"}}],"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:billsby/customer-get-credit-notes":{"get":{"operationId":"payments_billsby_customer_get_credit_notes","summary":"Customer credit notes","description":"GET /{companyDomain}/customers/{customerUniqueId}/creditNotes","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"customerUniqueId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/creditnote-reattempt-payment":{"post":{"operationId":"payments_billsby_creditnote_reattempt_payment","summary":"Reattempt credit note payment","description":"PUT /{companyDomain} /creditNotes /{creditNoteNumber} /Payment","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditNoteNumber","companyDomain"],"properties":{"creditNoteNumber":{"type":"string","description":"The unique identifier of the credit note in the Billsby platform"},"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}}}}},"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:billsby/product-get-details":{"get":{"operationId":"payments_billsby_product_get_details","summary":"Product details","description":"GET /{companyDomain}/products/{productId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"productId","in":"query","required":true,"description":"The unique identifier of the product in the Billsby platform","schema":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"}}],"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:billsby/product-update-product":{"post":{"operationId":"payments_billsby_product_update_product","summary":"Update a product","description":"PUT /{companyDomain}/products/{productId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","productID","productId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"productID":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"},"productId":{"type":"string","description":"Path parameter {productId}"},"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:billsby/product-list-products":{"get":{"operationId":"payments_billsby_product_list_products","summary":"List products","description":"GET /{companyDomain}/products","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"page","in":"query","required":true,"description":"The number of the page you would like to return","schema":{"type":"integer","description":"The number of the page you would like to return"}},{"name":"pageSize","in":"query","required":true,"description":"The number of entries per page you would like to return","schema":{"type":"integer","description":"The number of entries per page you would like to return"}},{"name":"search","in":"query","required":false,"description":"Filter products by name (this can be a partial name)","schema":{"type":"string","description":"Filter products by name (this can be a partial name)"}},{"name":"visibilityType","in":"query","required":false,"description":"The type of visibility of each product; public, hidden and on-sale. Available values: 0, 1, 2, 3 (Public=0, Hidden=1, Internal=2, OffSale=3)","schema":{"type":"integer","description":"The type of visibility of each product; public, hidden and on-sale. Available values: 0, 1, 2, 3 (Public=0, Hidden=1, Internal=2, OffSale=3)"}}],"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:billsby/product-create-new-product":{"post":{"operationId":"payments_billsby_product_create_new_product","summary":"Create a product","description":"POST /{companyDomain}/products","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"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:billsby/product-list-plans":{"get":{"operationId":"payments_billsby_product_list_plans","summary":"List plans","description":"GET /{companyDomain}/products/{productId}/plans","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"productId","in":"query","required":true,"description":"The unique identifier of the product in the Billsby platform","schema":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"}}],"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:billsby/product-create-plan":{"post":{"operationId":"payments_billsby_product_create_plan","summary":"Create a plan","description":"POST /{companyDomain}/products/{productId}/plans","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","productId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"productId":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"},"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:billsby/product-create-cycle":{"post":{"operationId":"payments_billsby_product_create_cycle","summary":"Create a cycle","description":"POST /{companyDomain}/products/{productId}/plans/{planId}/cycles","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","productId","planId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"productId":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"},"planId":{"type":"integer","description":"The unique identifier of the plan in the Billsby platform"},"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:billsby/product-update-plan-and-cycle":{"post":{"operationId":"payments_billsby_product_update_plan_and_cycle","summary":"Update a plan and cycle","description":"PUT /{companyDomain}/products/{productId}/plans/{planId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","productId","planId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"productId":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"},"planId":{"type":"integer","description":"The unique identifier of the plan in the Billsby platform"},"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:billsby/product-update-plan-order":{"post":{"operationId":"payments_billsby_product_update_plan_order","summary":"Update plan order","description":"PUT /{companyDomain}/products/{productId}/plans/orders","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","productId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"productId":{"type":"string","description":"The unique identifier of the product in the Billsby platform"},"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:billsby/subscription-get-counters-value":{"get":{"operationId":"payments_billsby_subscription_get_counters_value","summary":"Counter value","description":"GET /usage/{companyDomain}/subscriptions/{subscriptionUniqueId}/counters/{counterId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}},{"name":"counterId","in":"query","required":true,"description":"The unique identifier of the counter in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the counter in the Billsby platform"}},{"name":"from","in":"query","required":false,"description":"The date you would like the counter value from; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z","schema":{"type":"string","description":"The date you would like the counter value from; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z"}},{"name":"to","in":"query","required":false,"description":"The date you would like the counter value to; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z","schema":{"type":"string","description":"The date you would like the counter value to; format is ISO 8601, e.g. 2020-08-25T18:35:00.000Z"}}],"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:billsby/subscription-update-counter":{"post":{"operationId":"payments_billsby_subscription_update_counter","summary":"Update counter","description":"POST /operations/{companyDomain}/subscriptions/{subscriptionUniqueId}/counters/{counterId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","subscriptionUniqueId","counterId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"subscriptionUniqueId":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"},"counterId":{"type":"string","description":"The unique identifier of the counter in the Billsby platform"},"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:billsby/addon-list-available-addons":{"get":{"operationId":"payments_billsby_addon_list_available_addons","summary":"Get a list of available add-ons","description":"GET /{companyDomain}/addons","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}],"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:billsby/addon-get-details":{"get":{"operationId":"payments_billsby_addon_get_details","summary":"Get add-on details","description":"GET /{companyDomain}/addons/{addonId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"addonId","in":"query","required":true,"description":"The unique identifier of the add-on in the Billsby platform","schema":{"type":"integer","description":"The unique identifier of the add-on in the Billsby platform"}}],"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:billsby/allowance-get-list":{"get":{"operationId":"payments_billsby_allowance_get_list","summary":"Get a list of available allowances","description":"GET /{companyDomain}/allowances","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}],"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:billsby/allowance-get-details":{"get":{"operationId":"payments_billsby_allowance_get_details","summary":"Get allowance details","description":"GET /{companyDomain}/allowances/{allowanceId}","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"allowanceId","in":"query","required":true,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"integer","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/addon-get-addon-list":{"get":{"operationId":"payments_billsby_addon_get_addon_list","summary":"Get add-ons for specific subscription","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/addons","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/allowance-get-specific-subscription-allowances":{"get":{"operationId":"payments_billsby_allowance_get_specific_subscription_allowances","summary":"Get allowances for specific subscription","description":"GET /{companyDomain}/subscriptions/{subscriptionUniqueId}/allowances","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"subscriptionUniqueId","in":"query","required":true,"description":"The unique identifier of the subscription in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the subscription in the Billsby platform"}}],"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:billsby/custom-field-list":{"get":{"operationId":"payments_billsby_custom_field_list","summary":"Custom fields","description":"GET /{companyDomain}/customfields","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}}],"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:billsby/custom-field-create-new-field":{"post":{"operationId":"payments_billsby_custom_field_create_new_field","summary":"Create custom field","description":"POST /{companyDomain}/customfields","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"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:billsby/custom-field-update-field":{"post":{"operationId":"payments_billsby_custom_field_update_field","summary":"Update custom field","description":"PUT /{companyDomain}/customfields/{customFieldId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customFieldId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customFieldId":{"type":"string","description":"The unique identifier of the custom field in the Billsby platform"},"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:billsby/custom-field-get-response":{"get":{"operationId":"payments_billsby_custom_field_get_response","summary":"Custom fields response","description":"GET /{companyDomain}/customfieldResponses","tags":["payments"],"parameters":[{"name":"companyDomain","in":"query","required":true,"description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets","schema":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"}},{"name":"productId","in":"query","required":false,"description":"The unique identifier of the product in the Billsby platform","schema":{"type":"integer","description":"The unique identifier of the product in the Billsby platform"}},{"name":"customerUniqueId","in":"query","required":false,"description":"The unique identifier of the customer in the Billsby platform","schema":{"type":"string","description":"The unique identifier of the customer in the Billsby platform"}}],"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:billsby/customer-update-custom-field-response":{"post":{"operationId":"payments_billsby_customer_update_custom_field_response","summary":"Update customer response to custom fields","description":"PUT /{companyDomain}/customfieldResponses/{customFieldResponseId}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companyDomain","customFieldResponseId"],"properties":{"companyDomain":{"type":"string","description":"Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets"},"customFieldResponseId":{"type":"integer","description":"The unique identifier for an individual customers response to a question"},"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"}}},"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"}}}}}}}