From e3ccef529278004ca867de392be86bc9dda8052f Mon Sep 17 00:00:00 2001 From: Sergii Shapoval Date: Wed, 21 Jul 2021 21:04:20 +0300 Subject: [PATCH 1/2] fix(swagger): update reference to valid state for generation --- oas-swagger-stoplight.yaml | 4241 +++++++++++++++++------------------- 1 file changed, 1982 insertions(+), 2259 deletions(-) diff --git a/oas-swagger-stoplight.yaml b/oas-swagger-stoplight.yaml index 204805a..ba326b5 100644 --- a/oas-swagger-stoplight.yaml +++ b/oas-swagger-stoplight.yaml @@ -200,9 +200,7 @@ paths: expires_at: type: string last_invite_sent_at: - type: - - 'null' - - string + type: string examples: application/json: url: 'https://www.billingportal.com/manage/19804639/1517596469/bd16498719a7d3e6' @@ -736,14 +734,14 @@ paths: This request will return a list of components for a site. parameters: - - $ref: '#/parameters/trait:componentQueryString:date_field' - - $ref: '#/parameters/trait:componentQueryString:start_date' - - $ref: '#/parameters/trait:componentQueryString:end_date' - - $ref: '#/parameters/trait:componentQueryString:start_datetime' - - $ref: '#/parameters/trait:componentQueryString:end_datetime' - - $ref: '#/parameters/trait:includesArchive:include_archived' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3AcomponentQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AcomponentQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AcomponentQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AcomponentQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AcomponentQueryString%3Aend_datetime' + - $ref: '#/parameters/trait%3AincludesArchive%3Ainclude_archived' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -856,7 +854,7 @@ paths: This request will return a list of components for a particular product family. parameters: - - $ref: '#/parameters/trait:includesArchive:include_archived' + - $ref: '#/parameters/trait%3AincludesArchive%3Ainclude_archived' responses: '200': description: '' @@ -1078,11 +1076,11 @@ paths: If the price point is set to `use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': - $ref: '#/responses/trait:pagination20:200' + $ref: '#/responses/trait%3Apagination20%3A200' '201': description: '' schema: @@ -1154,7 +1152,7 @@ paths: '201': description: '' schema: - $ref: '#/definitions/components-create-response-post' + $ref: '#/definitions/components-price-points-create-price-point-response' security: - <>: [] x-stoplight: @@ -1263,7 +1261,7 @@ paths: description: |- When updating a price point, it's prices can be updated as well by creating new prices or editing / removing existing ones. - Passing in a price bracket without an `id` will attempt to create a new price. + Passing in a price bracket without an `id` will attempt to create a new price. Including an `id` will update the corresponding price, and including the `_destroy` flag set to true along with the `id` will remove that price. parameters: @@ -1357,9 +1355,7 @@ paths: starting_quantity: type: integer ending_quantity: - type: - - integer - - 'null' + type: integer # nullable unit_price: type: string examples: @@ -1728,9 +1724,9 @@ paths: component_id: type: integer price_point: - type: - - integer - - string + allOf: + - type: integer + - type: string message: type: string examples: @@ -1956,8 +1952,8 @@ paths: - name: body in: body schema: - type: 'null' - - $ref: '#/parameters/trait:pagination50:page' + type: string + - $ref: '#/parameters/trait%3Apagination50%3Apage' responses: '200': description: OK @@ -2200,17 +2196,15 @@ paths: subscription_id: type: integer quantity: - type: - - number - - integer + allOf: + - type: number + - type: integer previous_quantity: type: integer memo: type: string timestamp: - type: - - string - - 'null' + type: string proration_upgrade_scheme: type: string proration_downgrade_scheme: @@ -2516,7 +2510,7 @@ paths: You do not need to specify a price point ID. If a price point is not included, the default price point for the component will be used when the usage is recorded. - If an invalid `price_point_id` is submitted, the endpoint will return an error. + If an invalid `price_point_id` is submitted, the endpoint will return an error. ## Deducting Usage @@ -2610,9 +2604,9 @@ paths: This endpoint is not compatible with quantity-based components. - ## Since Date and Until Date Usage + ## Since Date and Until Date Usage - Note: The `since_date` and `until_date` attributes each default to midnight on the date specified. For example, in order to list usages for January 20th, you would need to append the following to the URL. + Note: The `since_date` and `until_date` attributes each default to midnight on the date specified. For example, in order to list usages for January 20th, you would need to append the following to the URL. ``` ?since_date=2016-01-20&until_date=2016-01-21 @@ -2622,12 +2616,12 @@ paths: Use this endpoint to read the previously recorded components for a subscription. You can now specify either the component id (integer) or the component handle prefixed by "handle:" to specify the unique identifier for the component you are working with. parameters: - - $ref: '#/parameters/trait:componentParameters:since_id' - - $ref: '#/parameters/trait:componentParameters:max_id' - - $ref: '#/parameters/trait:componentParameters:since_date' - - $ref: '#/parameters/trait:componentParameters:until_date' - - $ref: '#/parameters/trait:componentParameters:page' - - $ref: '#/parameters/trait:componentParameters:per_page' + - $ref: '#/parameters/trait%3AcomponentParameters%3Asince_id' + - $ref: '#/parameters/trait%3AcomponentParameters%3Amax_id' + - $ref: '#/parameters/trait%3AcomponentParameters%3Asince_date' + - $ref: '#/parameters/trait%3AcomponentParameters%3Auntil_date' + - $ref: '#/parameters/trait%3AcomponentParameters%3Apage' + - $ref: '#/parameters/trait%3AcomponentParameters%3Aper_page' responses: '200': description: '' @@ -2935,21 +2929,21 @@ paths: - next_assessment - updated_at - created_at - - $ref: '#/parameters/trait:subscriptionQueryString:page' - - $ref: '#/parameters/trait:subscriptionQueryString:per_page' - - $ref: '#/parameters/trait:subscriptionQueryString:state' - - $ref: '#/parameters/trait:subscriptionQueryString:product' - - $ref: '#/parameters/trait:subscriptionQueryString:product_price_point_id' - - $ref: '#/parameters/trait:subscriptionQueryString:coupon' - - $ref: '#/parameters/trait:subscriptionQueryString:date_field' - - $ref: '#/parameters/trait:subscriptionQueryString:start_date' - - $ref: '#/parameters/trait:subscriptionQueryString:end_date' - - $ref: '#/parameters/trait:subscriptionQueryString:start_datetime' - - $ref: '#/parameters/trait:subscriptionQueryString:end_datetime' - - $ref: '#/parameters/trait:subscriptionQueryString:metadata[Field Name]' - - $ref: '#/parameters/trait:subscriptionQueryString:direction' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Apage' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Aper_page' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Astate' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Aproduct' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Aproduct_price_point_id' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Acoupon' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Aend_datetime' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Ametadata%5BField%20Name%5D' + - $ref: '#/parameters/trait%3AsubscriptionQueryString%3Adirection' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -3367,8 +3361,8 @@ paths: This endpoint returns public keys used for Chargify.js. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -3427,7 +3421,7 @@ paths: description: |- ## Coupons Intro - Coupons can be administered in the Chargify application or created via API. Please view our section on [creating coupons](https://help.chargify.com/products/product-coupons.html) for more information. + Coupons can be administered in the Chargify application or created via API. Please view our section on [creating coupons](https://help.chargify.com/products/product-coupons.html) for more information. Additionally, for documentation on how to apply a coupon to a subscription within the Chargify UI, please see our documentation [here](https://help.chargify.com/subscriptions/subscription-summary.html#coupon). @@ -3455,9 +3449,9 @@ paths: - name: body in: body schema: - oneOf: - - $ref: '#/definitions/coupons-create-coupon-input-percentage' + allOf: - $ref: '#/definitions/coupons-create-coupon-input-flat-amount' + - $ref: '#/definitions/coupons-create-coupon-input-percentage' example: coupon: name: 15% off @@ -3479,9 +3473,9 @@ paths: '201': description: Created schema: - oneOf: - - $ref: '#/definitions/coupons-create-coupon-input-percentage' + allOf: - $ref: '#/definitions/coupons-create-coupon-input-flat-amount' + - $ref: '#/definitions/coupons-create-coupon-input-percentage' examples: application/json: coupon: @@ -3526,8 +3520,8 @@ paths: produces: - application/xml parameters: - - $ref: '#/parameters/trait:pagination30:page' - - $ref: '#/parameters/trait:pagination30:per_page' + - $ref: '#/parameters/trait%3Apagination30%3Apage' + - $ref: '#/parameters/trait%3Apagination30%3Aper_page' responses: '200': description: '' @@ -3711,11 +3705,11 @@ paths: If the coupon is set to `use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. parameters: - - $ref: '#/parameters/trait:couponQueryString:date_field' - - $ref: '#/parameters/trait:couponQueryString:start_date' - - $ref: '#/parameters/trait:couponQueryString:end_date' - - $ref: '#/parameters/trait:couponQueryString:start_datetime' - - $ref: '#/parameters/trait:couponQueryString:end_datetime' + - $ref: '#/parameters/trait%3AcouponQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AcouponQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AcouponQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AcouponQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AcouponQueryString%3Aend_datetime' responses: '200': description: OK @@ -3899,13 +3893,13 @@ paths: If the coupon is set to `use_site_exchange_rate: true`, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. parameters: - - $ref: '#/parameters/trait:pagination30:page' - - $ref: '#/parameters/trait:pagination30:per_page' - - $ref: '#/parameters/trait:couponQueryString:date_field' - - $ref: '#/parameters/trait:couponQueryString:start_date' - - $ref: '#/parameters/trait:couponQueryString:end_date' - - $ref: '#/parameters/trait:couponQueryString:start_datetime' - - $ref: '#/parameters/trait:couponQueryString:end_datetime' + - $ref: '#/parameters/trait%3Apagination30%3Apage' + - $ref: '#/parameters/trait%3Apagination30%3Aper_page' + - $ref: '#/parameters/trait%3AcouponQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AcouponQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AcouponQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AcouponQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AcouponQueryString%3Aend_datetime' responses: '200': description: OK @@ -4211,11 +4205,11 @@ paths: For example: - Master Coupon Code: + Master Coupon Code: + SPRING2020 - Coupon Subcodes: + Coupon Subcodes: + SPRING90210 + DP80302 @@ -4243,7 +4237,7 @@ paths: - to %2D _ to %5F . to %2E - + So, if the coupon subcode is `20%OFF`, the URL to delete this coupon subcode would be: `https://.chargify.com/coupons/567/codes/20%25OFF.` parameters: - name: body @@ -4289,8 +4283,8 @@ paths: This request allows you to request the subcodes that are attached to a coupon. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -4361,8 +4355,8 @@ paths: - AAAA - BBBB - CCCC - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: OK @@ -4410,7 +4404,7 @@ paths: ## Example - Given a coupon with an ID of 567, and a coupon subcode of 20OFF, the URL to `DELETE` this coupon subcode would be: + Given a coupon with an ID of 567, and a coupon subcode of 20OFF, the URL to `DELETE` this coupon subcode would be: ``` http://subdomain.chargify.com/coupons/567/codes/20OFF. @@ -4472,13 +4466,13 @@ paths: ## Metafields Documentation - Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. + Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https://help.chargify.com/custom-fields/custom-fields-intro.html). For additional documentation on how to record data within custom fields, please see our subscription-based documentation [here.](https://help.chargify.com/subscriptions/subscription-summary.html#custom-fields) - ## Metafields vs Metadata + ## Metafields vs Metadata Metadata is the information that populates the metafield. @@ -4498,7 +4492,7 @@ paths: + csv + invoices + statements - + If configuring metafields in the Admin UI or via the API, be careful sending updates to metafields with the scope attribute – if a partial update is sent it will overwrite the current configuration. ## CSV Metafields @@ -4539,7 +4533,7 @@ paths: Use the following method to create metafields for your Site. Metafields can be populated with metadata after the fact. - ## Create Multiple Metafields + ## Create Multiple Metafields In order to create multiple metafields in one request, use the following JSON format: @@ -4585,8 +4579,8 @@ paths: enum: - option 1 - option 2 - - $ref: '#/parameters/trait:metafieldsNameRequiredCurrentNameOptional:name' - - $ref: '#/parameters/trait:metafieldsNameRequiredCurrentNameOptional:current_name' + - $ref: '#/parameters/trait%3AmetafieldsNameRequiredCurrentNameOptional%3Aname' + - $ref: '#/parameters/trait%3AmetafieldsNameRequiredCurrentNameOptional%3Acurrent_name' responses: '200': description: '' @@ -4637,9 +4631,9 @@ paths: This endpoint lists metafields associated with a Site. The metafield description and usage is contained in the response. parameters: - - $ref: '#/parameters/trait:metafieldsNameOptional:name' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3AmetafieldsNameOptional%3Aname' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -4700,7 +4694,7 @@ paths: invoices: '1' statements: '1' portal: '0' - - $ref: '#/parameters/trait:metafieldsNameRequired:name' + - $ref: '#/parameters/trait%3AmetafieldsNameRequired%3Aname' responses: '200': description: '' @@ -4737,7 +4731,7 @@ paths: description: |- ## Delete Metafields - Use the following method to delete a metafield. This will remove the metafield from the Site. + Use the following method to delete a metafield. This will remove the metafield from the Site. Additionally, this will remove the metafield and associated metadata with all Subscriptions on the Site. @@ -4747,7 +4741,7 @@ paths: ```https://my-subdomain.chargify.com/customers/metafields.json?name=strength``` parameters: - - $ref: '#/parameters/trait:metafieldsNameRequired:name' + - $ref: '#/parameters/trait%3AmetafieldsNameRequired%3Aname' responses: '200': description: '' @@ -4796,7 +4790,7 @@ paths: ## Metadata Documentation - Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. + Within the Chargify UI, metadata and metafields are grouped together under the umbrella of "Custom Fields." All of our UI-based documentation that references custom fields will not cite the terminology metafields or metadata. Full documentation on how to create Custom Fields in the Chargify UI can be located [here](https://help.chargify.com/custom-fields/custom-fields-intro.html). @@ -4833,7 +4827,7 @@ paths: value: Blue - name: Something value: Useful - - $ref: '#/parameters/trait:metadataValue:value' + - $ref: '#/parameters/trait%3AmetadataValue%3Avalue' responses: default: description: '' @@ -4863,8 +4857,8 @@ paths: This endpoint will also display the current stats of your metadata to use as a tool for pagination. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -4902,7 +4896,7 @@ paths: description: |- ## Update Metadata - This method allows you to update the existing metadata associated with a subscription or customer. + This method allows you to update the existing metadata associated with a subscription or customer. ## URL Construction @@ -4937,7 +4931,7 @@ paths: current_name: Color name: Shirt Color value: Blue - - $ref: '#/parameters/trait:metadataValue:value' + - $ref: '#/parameters/trait%3AmetadataValue%3Avalue' responses: '200': description: '' @@ -5043,7 +5037,7 @@ paths: `https://acme.chargify.com/subscriptions/metadata.json?resource_ids[]=1&resource_ids[]=2` - ## Read Metadata for a Site + ## Read Metadata for a Site This endpoint will list the number of pages of metadata information that are contained within a site. parameters: @@ -5052,14 +5046,14 @@ paths: type: array items: type: string - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:metadataQueryString:date_field' - - $ref: '#/parameters/trait:metadataQueryString:start_date' - - $ref: '#/parameters/trait:metadataQueryString:end_date' - - $ref: '#/parameters/trait:metadataQueryString:start_datetime' - - $ref: '#/parameters/trait:metadataQueryString:end_datetime' - - $ref: '#/parameters/trait:metadataQueryString:with_deleted' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Aend_datetime' + - $ref: '#/parameters/trait%3AmetadataQueryString%3Awith_deleted' responses: '200': description: '' @@ -5099,7 +5093,7 @@ paths: description: |- ## Customers Intro - You may create a new Customer at any time, or you may create a Customer at the same time you create a Subscription. The only validation restriction is that you may only create one customer for a given reference value. + You may create a new Customer at any time, or you may create a Customer at the same time you create a Subscription. The only validation restriction is that you may only create one customer for a given reference value. If provided, the `reference` value must be unique. It represents a unique identifier for the customer from your own app, i.e. the customer’s ID. This allows you to retrieve a given customer via a piece of shared information. Alternatively, you may choose to leave `reference` blank, and store Chargify’s unique ID for the customer, which is in the `id` attribute. @@ -5256,13 +5250,13 @@ paths: This request will list all customers associated with your Site. parameters: - - $ref: '#/parameters/trait:direction:direction' - - $ref: '#/parameters/trait:pagination50:page' - - $ref: '#/parameters/trait:customerQueryString:date_field' - - $ref: '#/parameters/trait:customerQueryString:start_date' - - $ref: '#/parameters/trait:customerQueryString:end_date' - - $ref: '#/parameters/trait:customerQueryString:start_datetime' - - $ref: '#/parameters/trait:customerQueryString:end_datetime' + - $ref: '#/parameters/trait%3Adirection%3Adirection' + - $ref: '#/parameters/trait%3Apagination50%3Apage' + - $ref: '#/parameters/trait%3AcustomerQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AcustomerQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AcustomerQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AcustomerQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AcustomerQueryString%3Aend_datetime' responses: '200': description: '' @@ -6037,7 +6031,7 @@ paths: required: true type: string get: - operationId: list-events + operationId: list-subscription-events summary: List Events for Subscription tags: - Event @@ -6054,13 +6048,13 @@ paths: in: query description: Any of the events listed under the introduction. `?filter=payment_success' type: string - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:eventsBasicFilters:page' - - $ref: '#/parameters/trait:eventsBasicFilters:per_page' - - $ref: '#/parameters/trait:eventsBasicFilters:since_id' - - $ref: '#/parameters/trait:eventsBasicFilters:max_id' - - $ref: '#/parameters/trait:eventsBasicFilters:direction' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Apage' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Aper_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Asince_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Amax_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Adirection' responses: '200': description: OK @@ -6096,7 +6090,7 @@ paths: security: - <>: [] x-stoplight: - id: list-events + id: list-subscription-events beforeScript: null afterScript: null public: true @@ -6175,19 +6169,19 @@ paths: } ``` parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:eventsBasicFilters:page' - - $ref: '#/parameters/trait:eventsBasicFilters:per_page' - - $ref: '#/parameters/trait:eventsBasicFilters:since_id' - - $ref: '#/parameters/trait:eventsBasicFilters:max_id' - - $ref: '#/parameters/trait:eventsBasicFilters:direction' - - $ref: '#/parameters/trait:filterByEventName:filter' - - $ref: '#/parameters/trait:eventsQueryString:date_field' - - $ref: '#/parameters/trait:eventsQueryString:start_date' - - $ref: '#/parameters/trait:eventsQueryString:end_date' - - $ref: '#/parameters/trait:eventsQueryString:start_datetime' - - $ref: '#/parameters/trait:eventsQueryString:end_datetime' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Apage' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Aper_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Asince_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Amax_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Adirection' + - $ref: '#/parameters/trait%3AfilterByEventName%3Afilter' + - $ref: '#/parameters/trait%3AeventsQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AeventsQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AeventsQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AeventsQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AeventsQueryString%3Aend_datetime' responses: '200': description: OK @@ -6247,19 +6241,19 @@ paths: in: body schema: $ref: '#/definitions/event-count' - - $ref: '#/parameters/trait:eventsBasicFilters:page' - - $ref: '#/parameters/trait:eventsBasicFilters:per_page' - - $ref: '#/parameters/trait:eventsBasicFilters:since_id' - - $ref: '#/parameters/trait:eventsBasicFilters:max_id' - - $ref: '#/parameters/trait:eventsBasicFilters:direction' - - $ref: '#/parameters/trait:filterByEventName:filter' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Apage' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Aper_page' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Asince_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Amax_id' + - $ref: '#/parameters/trait%3AeventsBasicFilters%3Adirection' + - $ref: '#/parameters/trait%3AfilterByEventName%3Afilter' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: OK schema: - $ref: '#/definitions/Count' + $ref: '#/definitions/count-transactions' examples: application/json: count: 144 @@ -6776,319 +6770,320 @@ paths: enabled: false dynamic: false statusCode: 200 - '/invoices/{invoice_id}.json': - parameters: - - name: invoice_id - in: path - description: '' - required: true - type: integer - get: - operationId: GET_invoices-invoice_id-format - summary: Read Legacy Invoice - tags: - - Invoice - - incomplete - - Invoices (Legacy) - description: |- - ## Read Legacy Invoice - - This method will retrieve the invoice object based on the ID provided. - - ## PDF Invoice retrieval - - Individual PDF Invoices can be retrieved by using the "Accept/Content-Type" header application/pdf or appending .pdf as the format portion of the URL: - - ```curl -u :x -H - Accept:application/pdf -H - Content-Type:application/pdf - https://acme.chargify.com/invoices/1.pdf > output_file.pdf - - URL: `https://.chargify.com/invoices/.` - Method: GET - Required parameters: `invoice_id` - Response: A single Invoice. - ``` - parameters: - - $ref: '#/parameters/trait:startdateEnddateQuery:start_date' - - $ref: '#/parameters/trait:startdateEnddateQuery:end_date' - responses: - '200': - description: OK - schema: - type: object - properties: - invoice: - $ref: '#/definitions/legacy-invoice' - examples: - application/json: - invoice: - id: 1240345 - subscription_id: 14900541 - statement_id: 79334531 - site_id: 31615 - state: paid - total_amount_in_cents: 4250 - paid_at: '2016-11-01T12:20:21-04:00' - created_at: '2016-10-26T14:38:40-04:00' - updated_at: '2016-11-01T12:20:21-04:00' - amount_due_in_cents: 0 - number: '000014' - charges: - - created_at: '2016-10-26T14:38:39-04:00' - subscription_id: 14900541 - type: Charge - memo: Basic Plan (10/26/2016 - 11/26/2016) - kind: baseline - amount_in_cents: 4000 - ending_balance_in_cents: 4000 - success: true - id: 159670144 - payment_id: 160493169 - product_id: 3792003 - transaction_type: charge - gateway_transaction_id: null - gateway_order_id: null - starting_balance_in_cents: 0 - component_id: null - tax_id: null - customer_id: 14399371 - - created_at: '2016-10-26T14:38:39-04:00' - subscription_id: 14900541 - type: Charge - memo: MA Tax (6.25%) - kind: tax - amount_in_cents: 250 - ending_balance_in_cents: 4250 - success: true - id: 159670145 - payment_id: 160493169 - product_id: 3792003 - transaction_type: charge - gateway_transaction_id: null - gateway_order_id: null - starting_balance_in_cents: 4000 - component_id: null - tax_id: null - customer_id: 14399371 - payments_and_credits: - - created_at: '2016-11-01T12:20:20-04:00' - subscription_id: 14900541 - type: Payment - memo: One Time Credit Card Payment for Invoice - kind: one_time - amount_in_cents: 4250 - ending_balance_in_cents: -4450 - success: true - id: 160493169 - payment_id: null - product_id: 3792003 - transaction_type: payment - gateway_transaction_id: '53433' - gateway_order_id: null - starting_balance_in_cents: -200 - component_id: null - tax_id: null - customer_id: 14399371 - card_number: XXXX-XXXX-XXXX-1 - card_expiration: 01/2026 - card_type: bogus - '404': - description: Not Found - security: - - <>: [] - x-stoplight: - id: GET_invoices-invoice_id-format - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - statusCode: 200 - '/invoices/{invoice_id}/payments.json': - parameters: - - name: invoice_id - in: path - required: true - type: string - post: - operationId: POST_invoices-invoice_id-payments-json - summary: Create Payment - tags: - - Invoices (Legacy) - description: |- - ## Create External Payment for Legacy Invoice - - In order to specify a payment made against an invoice, specify the `amount`. - - Please note that you may request the payment `amount_in_cents`. You may submit your request in cents as well: - - ``` - { - "payment": { - "amount": 10.00, - "memo": "Lorem ipsum" - } - } - ``` - - ## Invoice Payment Documentation - - For more information that on adding a payment to an invoice, please see our payment documentation below: - - + [Pay via Card](https://help.chargify.com/invoices/invoice-reference.html#pay-with-card) - + [Offline Payments](https://help.chargify.com/invoices/invoice-reference.html#enter-payment) - parameters: - - name: body - in: body - schema: - $ref: '#/definitions/create-external-payment' - responses: - '200': - description: '' - schema: - $ref: '#/definitions/payment' - examples: - application/json: - payment: - id: 160567068 - subscription_id: 14900541 - type: Payment - kind: manual - transaction_type: payment - success: true - amount_in_cents: 1000 - memo: Lorem ipsum - created_at: '2016-11-01T16:04:37-04:00' - starting_balance_in_cents: 3750 - ending_balance_in_cents: 2750 - gateway_used: null - gateway_transaction_id: null - gateway_order_id: null - payment_id: null - product_id: 3792003 - tax_id: null - component_id: null - statement_id: 79733833 - customer_id: 14399371 - card_number: null - card_expiration: null - card_type: null - refunded_amount_in_cents: 0 - security: - - <>: [] - x-stoplight: - id: POST_invoices-invoiceid-paymentsjson - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - dynamic: false - statusCode: 200 - '/invoices/{invoice_id}/charges.json': - parameters: - - name: invoice_id - in: path - required: true - type: string - post: - operationId: POST_invoices-invoice_id-charges-json - summary: Create Charge - tags: - - Invoices (Legacy) - description: |- - ## Invoice Charges Documentation - - For more information on adding a charge to an invoice, please see our documentation [here](https://help.chargify.com/invoices/invoice-reference.html#add-charge). - parameters: - - name: body - in: body - schema: - $ref: '#/definitions/create-charge-for-legacy-invoice' - example: - charge: - amount: '10.00' - memo: Support October 2016 - responses: - '200': - description: '' - schema: - $ref: '#/definitions/charge' - security: - - <>: [] - x-stoplight: - id: POST_invoices-invoiceid-chargesjson - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - dynamic: false - statusCode: 200 - '/invoices/{invoice_id}/adjustments.json': - parameters: - - name: invoice_id - in: path - required: true - type: string - post: - operationId: POST_invoices-invoice_id-adjustments-json - summary: Create Credit - tags: - - Invoices (Legacy) - description: |- - ## Create Invoice Credit - - Use this method to add a credit to an existing invoice. - parameters: - - name: body - in: body - schema: - $ref: '#/definitions/create-credit-for-legacy-invoice' - example: - adjustment: - amount: 10 - memo: Credit for recycling old computers - responses: - '200': - description: '' - schema: - $ref: '#/definitions/credit' - examples: - application/json: - adjustment: - id: 165068820 - subscription_id: 14823581 - type: Adjustment - kind: null - transaction_type: adjustment - success: true - amount_in_cents: -1000 - memo: Credit for recycling old computers - created_at: '2016-12-05T13:37:28-05:00' - starting_balance_in_cents: 177 - ending_balance_in_cents: -823 - gateway_used: null - gateway_transaction_id: null - gateway_order_id: null - payment_id: null - product_id: 3794121 - tax_id: null - component_id: null - statement_id: 79335006 - customer_id: 14332342 - security: - - <>: [] - x-stoplight: - id: POST_invoices-invoiceid-adjustmentsjson - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - dynamic: false - statusCode: 200 + # legacy invoices endpoint + # '/invoices/{invoice_id}.json': + # parameters: + # - name: invoice_id + # in: path + # description: '' + # required: true + # type: integer + # get: + # operationId: GET_invoices-invoice_id-format + # summary: Read Legacy Invoice + # tags: + # - Invoice + # - incomplete + # - Invoices (Legacy) + # description: |- + # ## Read Legacy Invoice + # + # This method will retrieve the invoice object based on the ID provided. + # + # ## PDF Invoice retrieval + # + # Individual PDF Invoices can be retrieved by using the "Accept/Content-Type" header application/pdf or appending .pdf as the format portion of the URL: + # + # ```curl -u :x -H + # Accept:application/pdf -H + # Content-Type:application/pdf + # https://acme.chargify.com/invoices/1.pdf > output_file.pdf + # + # URL: `https://.chargify.com/invoices/.` + # Method: GET + # Required parameters: `invoice_id` + # Response: A single Invoice. + # ``` + # parameters: + # - $ref: '#/parameters/trait%3AstartdateEnddateQuery%3Astart_date' + # - $ref: '#/parameters/trait%3AstartdateEnddateQuery%3Aend_date' + # responses: + # '200': + # description: OK + # schema: + # type: object + # properties: + # invoice: + # $ref: '#/definitions/legacy-invoice' + # examples: + # application/json: + # invoice: + # id: 1240345 + # subscription_id: 14900541 + # statement_id: 79334531 + # site_id: 31615 + # state: paid + # total_amount_in_cents: 4250 + # paid_at: '2016-11-01T12:20:21-04:00' + # created_at: '2016-10-26T14:38:40-04:00' + # updated_at: '2016-11-01T12:20:21-04:00' + # amount_due_in_cents: 0 + # number: '000014' + # charges: + # - created_at: '2016-10-26T14:38:39-04:00' + # subscription_id: 14900541 + # type: Charge + # memo: Basic Plan (10/26/2016 - 11/26/2016) + # kind: baseline + # amount_in_cents: 4000 + # ending_balance_in_cents: 4000 + # success: true + # id: 159670144 + # payment_id: 160493169 + # product_id: 3792003 + # transaction_type: charge + # gateway_transaction_id: null + # gateway_order_id: null + # starting_balance_in_cents: 0 + # component_id: null + # tax_id: null + # customer_id: 14399371 + # - created_at: '2016-10-26T14:38:39-04:00' + # subscription_id: 14900541 + # type: Charge + # memo: MA Tax (6.25%) + # kind: tax + # amount_in_cents: 250 + # ending_balance_in_cents: 4250 + # success: true + # id: 159670145 + # payment_id: 160493169 + # product_id: 3792003 + # transaction_type: charge + # gateway_transaction_id: null + # gateway_order_id: null + # starting_balance_in_cents: 4000 + # component_id: null + # tax_id: null + # customer_id: 14399371 + # payments_and_credits: + # - created_at: '2016-11-01T12:20:20-04:00' + # subscription_id: 14900541 + # type: Payment + # memo: One Time Credit Card Payment for Invoice + # kind: one_time + # amount_in_cents: 4250 + # ending_balance_in_cents: -4450 + # success: true + # id: 160493169 + # payment_id: null + # product_id: 3792003 + # transaction_type: payment + # gateway_transaction_id: '53433' + # gateway_order_id: null + # starting_balance_in_cents: -200 + # component_id: null + # tax_id: null + # customer_id: 14399371 + # card_number: XXXX-XXXX-XXXX-1 + # card_expiration: 01/2026 + # card_type: bogus + # '404': + # description: Not Found + # security: + # - <>: [] + # x-stoplight: + # id: GET_invoices-invoice_id-format + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # statusCode: 200 + # '/invoices/{invoice_id}/payments.json': + # parameters: + # - name: invoice_id + # in: path + # required: true + # type: string + # post: + # operationId: POST_invoices-invoice_id-payments-json + # summary: Create Payment + # tags: + # - Invoices (Legacy) + # description: |- + # ## Create External Payment for Legacy Invoice + # + # In order to specify a payment made against an invoice, specify the `amount`. + # + # Please note that you may request the payment `amount_in_cents`. You may submit your request in cents as well: + # + # ``` + # { + # "payment": { + # "amount": 10.00, + # "memo": "Lorem ipsum" + # } + # } + # ``` + # + # ## Invoice Payment Documentation + # + # For more information that on adding a payment to an invoice, please see our payment documentation below: + # + # + [Pay via Card](https://help.chargify.com/invoices/invoice-reference.html#pay-with-card) + # + [Offline Payments](https://help.chargify.com/invoices/invoice-reference.html#enter-payment) + # parameters: + # - name: body + # in: body + # schema: + # $ref: '#/definitions/create-external-payment' + # responses: + # '200': + # description: '' + # schema: + # $ref: '#/definitions/payment' + # examples: + # application/json: + # payment: + # id: 160567068 + # subscription_id: 14900541 + # type: Payment + # kind: manual + # transaction_type: payment + # success: true + # amount_in_cents: 1000 + # memo: Lorem ipsum + # created_at: '2016-11-01T16:04:37-04:00' + # starting_balance_in_cents: 3750 + # ending_balance_in_cents: 2750 + # gateway_used: null + # gateway_transaction_id: null + # gateway_order_id: null + # payment_id: null + # product_id: 3792003 + # tax_id: null + # component_id: null + # statement_id: 79733833 + # customer_id: 14399371 + # card_number: null + # card_expiration: null + # card_type: null + # refunded_amount_in_cents: 0 + # security: + # - <>: [] + # x-stoplight: + # id: POST_invoices-invoiceid-paymentsjson + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # dynamic: false + # statusCode: 200 + # '/invoices/{invoice_id}/charges.json': + # parameters: + # - name: invoice_id + # in: path + # required: true + # type: string + # post: + # operationId: POST_invoices-invoice_id-charges-json + # summary: Create Charge + # tags: + # - Invoices (Legacy) + # description: |- + # ## Invoice Charges Documentation + # + # For more information on adding a charge to an invoice, please see our documentation [here](https://help.chargify.com/invoices/invoice-reference.html#add-charge). + # parameters: + # - name: body + # in: body + # schema: + # $ref: '#/definitions/create-charge-for-legacy-invoice' + # example: + # charge: + # amount: '10.00' + # memo: Support October 2016 + # responses: + # '200': + # description: '' + # schema: + # $ref: '#/definitions/charge' + # security: + # - <>: [] + # x-stoplight: + # id: POST_invoices-invoiceid-chargesjson + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # dynamic: false + # statusCode: 200 + # '/invoices/{invoice_id}/adjustments.json': + # parameters: + # - name: invoice_id + # in: path + # required: true + # type: string + # post: + # operationId: POST_invoices-invoice_id-adjustments-json + # summary: Create Credit + # tags: + # - Invoices (Legacy) + # description: |- + # ## Create Invoice Credit + # + # Use this method to add a credit to an existing invoice. + # parameters: + # - name: body + # in: body + # schema: + # $ref: '#/definitions/create-credit-for-legacy-invoice' + # example: + # adjustment: + # amount: 10 + # memo: Credit for recycling old computers + # responses: + # '200': + # description: '' + # schema: + # $ref: '#/definitions/credit' + # examples: + # application/json: + # adjustment: + # id: 165068820 + # subscription_id: 14823581 + # type: Adjustment + # kind: null + # transaction_type: adjustment + # success: true + # amount_in_cents: -1000 + # memo: Credit for recycling old computers + # created_at: '2016-12-05T13:37:28-05:00' + # starting_balance_in_cents: 177 + # ending_balance_in_cents: -823 + # gateway_used: null + # gateway_transaction_id: null + # gateway_order_id: null + # payment_id: null + # product_id: 3794121 + # tax_id: null + # component_id: null + # statement_id: 79335006 + # customer_id: 14332342 + # security: + # - <>: [] + # x-stoplight: + # id: POST_invoices-invoiceid-adjustmentsjson + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # dynamic: false + # statusCode: 200 '/invoices/{uid}.json': parameters: - name: uid @@ -7390,7 +7385,7 @@ paths: Exposed event types are: - + issue_invoice + + issue_invoice + apply_credit_note + apply_payment + refund_invoice @@ -7418,10 +7413,10 @@ paths: in: query description: 'Filter results by event_type. Supply a comma separated list of event types (listed above). eg: void_invoice,void_remainder' type: string - - $ref: '#/parameters/trait:relationshipInvoicingTraits:since_date' - - $ref: '#/parameters/trait:relationshipInvoicingTraits:since_id' - - $ref: '#/parameters/trait:relationshipInvoicingTraits:page' - - $ref: '#/parameters/trait:relationshipInvoicingTraits:per_page' + - $ref: '#/parameters/trait%3ArelationshipInvoicingTraits%3Asince_date' + - $ref: '#/parameters/trait%3ArelationshipInvoicingTraits%3Asince_id' + - $ref: '#/parameters/trait%3ArelationshipInvoicingTraits%3Apage' + - $ref: '#/parameters/trait%3ArelationshipInvoicingTraits%3Aper_page' responses: '200': description: '' @@ -7793,9 +7788,9 @@ paths: - amount properties: amount: - type: - - string - - number + allOf: + - type: string + - type: number description: A string of the dollar amount to be refunded (eg. "10.50" => $10.50) memo: type: string @@ -7823,7 +7818,7 @@ paths: - prepayment - service_credit description: | - The type of payment to be applied to an Invoice. + The type of payment to be applied to an Invoice. required: - payment example: @@ -8461,11 +8456,11 @@ paths: type: object properties: errors: - type: - - string - - array + allOf: + - type: string + - type: array description: |- - Unproccessable Entity Possible Errors: + Unproccessable Entity Possible Errors: "Payment amount, details, method, and memo must be present" "Payment amount, details, method, and memo must valid" @@ -8520,7 +8515,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string '422': description: '' schema: @@ -8589,7 +8584,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string '422': description: '' schema: @@ -9665,8 +9660,8 @@ paths: sticky: false subscription_id: 100046 updated_at: '2015-06-15T13:26:33-04:00' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: OK @@ -10078,7 +10073,7 @@ paths: ## Stripe SEPA Direct Debit Payment Profiles - The following table depicts what are the elements that are used when creating Stripe Direct Debit Payment Profiles. Please note these key/value pairs do closely resemble ACH elements. However, we've created this endpoint to focus on how to formulate a request for creating a Stripe Direct Debit payment profile. + The following table depicts what are the elements that are used when creating Stripe Direct Debit Payment Profiles. Please note these key/value pairs do closely resemble ACH elements. However, we've created this endpoint to focus on how to formulate a request for creating a Stripe Direct Debit payment profile. | bank_name | (Optional when creating a subscription with Stripe Direct Debit). The name of the bank where the customerʼs account resides | |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -10174,15 +10169,13 @@ paths: billing_country: type: string customer_vault_token: - type: - - string - - 'null' + type: string #nullable billing_address_2: - type: 'null' + type: string bank_name: type: string masked_bank_routing_number: - type: 'null' + type: string masked_bank_account_number: type: string bank_account_type: @@ -10256,8 +10249,8 @@ paths: in: query description: The ID of the customer for which you wish to list payment profiles type: integer - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: OK @@ -10329,7 +10322,7 @@ paths: description: |- ## Read a Payment Profile - Bank Account - Using the GET method you can retrieve a Payment Profile identified by its unique ID. + Using the GET method you can retrieve a Payment Profile identified by its unique ID. Please note that a different JSON object will be returned if the card method on file is a credit card. responses: @@ -10384,7 +10377,7 @@ paths: ## Partial Card Updates - In the event that you are using the Authorize.net, Stripe, Cybersource, Forte or Braintree Blue payment gateways, you can update just the billing and contact information for a payment method. Note the lack of credit-card related data contained in the JSON payload. + In the event that you are using the Authorize.net, Stripe, Cybersource, Forte or Braintree Blue payment gateways, you can update just the billing and contact information for a payment method. Note the lack of credit-card related data contained in the JSON payload. In this case, the following JSON is acceptable: @@ -10403,7 +10396,7 @@ paths: } ``` - The result will be that you have updated the billing information for the card, yet retained the original card number data. + The result will be that you have updated the billing information for the card, yet retained the original card number data. ## Specific notes on updating payment profiles @@ -10821,13 +10814,13 @@ paths: in: query type: boolean default: false - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:productQueryString:date_field' - - $ref: '#/parameters/trait:productQueryString:start_date' - - $ref: '#/parameters/trait:productQueryString:end_date' - - $ref: '#/parameters/trait:productQueryString:start_datetime' - - $ref: '#/parameters/trait:productQueryString:end_datetime' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AproductQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AproductQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AproductQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AproductQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AproductQueryString%3Aend_datetime' responses: '200': description: OK @@ -10997,7 +10990,7 @@ paths: description: |- ## Update a Product - Use this method to change aspects of an existing product. + Use this method to change aspects of an existing product. ### Input Attributes Update Notes @@ -11026,7 +11019,7 @@ paths: '200': description: '' schema: - $ref: '#/definitions/products/update-a-product-output' + $ref: '#/definitions/products-create-a-product-output' examples: application/json: product: @@ -11099,7 +11092,7 @@ paths: description: |- ## Archive a Product - Sending a DELETE request to this endpoint will archive the product. All current subscribers will be unffected; their subscription/purchase will continue to be charged monthyl. + Sending a DELETE request to this endpoint will archive the product. All current subscribers will be unffected; their subscription/purchase will continue to be charged monthyl. This will restrict the option to chose the product for purchase via the Billing Portal, as well as disable Public Signup Pages for the product. responses: @@ -11240,162 +11233,163 @@ paths: mock: enabled: false statusCode: 200 - '/products/{id}.json': - parameters: - - name: id - in: path - description: Product ID. - required: true - type: number - get: - operationId: GET_products-id-format - summary: Read the Product by Product ID - tags: - - Product - - Note - - incomplete - - Products - description: |- - ## Read the Product by ID - - This method allows to retrieve a Product object by its the `product_id`. The response will contain a single product object. - responses: - '200': - description: OK - schema: - type: object - properties: - product: - type: object - properties: - id: - type: integer - name: - type: string - handle: - type: string - description: - type: string - accounting_code: - type: string - request_credit_card: - type: boolean - expiration_interval: - type: 'null' - expiration_interval_unit: - type: string - created_at: - type: string - updated_at: - type: string - price_in_cents: - type: integer - interval: - type: integer - interval_unit: - type: string - initial_charge_in_cents: - type: 'null' - trial_price_in_cents: - type: integer - trial_interval: - type: integer - trial_interval_unit: - type: string - archived_at: - type: 'null' - require_credit_card: - type: boolean - return_params: - type: string - taxable: - type: boolean - update_return_url: - type: string - initial_charge_after_trial: - type: boolean - version_number: - type: integer - update_return_params: - type: string - product_family: - type: object - properties: - id: - type: integer - name: - type: string - description: - type: string - handle: - type: string - accounting_code: - type: 'null' - public_signup_pages: - type: array - items: - type: object - properties: - id: - type: integer - return_url: - type: string - return_params: - type: string - url: - type: string - product_price_point_name: - type: string - examples: - application/json: - product: - id: 3861800 - name: Trial Product - handle: trial-product - description: Trial period with payment expected at end of trial. - accounting_code: '' - request_credit_card: true - expiration_interval: null - expiration_interval_unit: never - created_at: '2016-07-08T09:53:55-04:00' - updated_at: '2016-09-05T13:00:36-04:00' - price_in_cents: 1000 - interval: 1 - interval_unit: month - initial_charge_in_cents: null - trial_price_in_cents: 0 - trial_interval: 7 - trial_interval_unit: day - archived_at: null - require_credit_card: true - return_params: '' - taxable: false - update_return_url: '' - initial_charge_after_trial: false - version_number: 6 - update_return_params: '' - product_family: - id: 527890 - name: Acme Projects - description: '' - handle: billing-plans - accounting_code: null - public_signup_pages: - - id: 294791 - return_url: '' - return_params: '' - url: 'https://general-goods.chargify.com/subscribe/xv52yrcc3byx/trial-product' - product_price_point_name: Default - security: - - <>: [] - x-stoplight: - id: GET_products-id-format - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - statusCode: 200 + # another similar endpoint exists + # '/products/{id}.json': + # parameters: + # - name: id + # in: path + # description: Product ID. + # required: true + # type: number + # get: + # operationId: GET_products-id-format + # summary: Read the Product by Product ID + # tags: + # - Product + # - Note + # - incomplete + # - Products + # description: |- + # ## Read the Product by ID + # + # This method allows to retrieve a Product object by its the `product_id`. The response will contain a single product object. + # responses: + # '200': + # description: OK + # schema: + # type: object + # properties: + # product: + # type: object + # properties: + # id: + # type: integer + # name: + # type: string + # handle: + # type: string + # description: + # type: string + # accounting_code: + # type: string + # request_credit_card: + # type: boolean + # expiration_interval: + # type: string + # expiration_interval_unit: + # type: string + # created_at: + # type: string + # updated_at: + # type: string + # price_in_cents: + # type: integer + # interval: + # type: integer + # interval_unit: + # type: string + # initial_charge_in_cents: + # type: string + # trial_price_in_cents: + # type: integer + # trial_interval: + # type: integer + # trial_interval_unit: + # type: string + # archived_at: + # type: string + # require_credit_card: + # type: boolean + # return_params: + # type: string + # taxable: + # type: boolean + # update_return_url: + # type: string + # initial_charge_after_trial: + # type: boolean + # version_number: + # type: integer + # update_return_params: + # type: string + # product_family: + # type: object + # properties: + # id: + # type: integer + # name: + # type: string + # description: + # type: string + # handle: + # type: string + # accounting_code: + # type: string + # public_signup_pages: + # type: array + # items: + # type: object + # properties: + # id: + # type: integer + # return_url: + # type: string + # return_params: + # type: string + # url: + # type: string + # product_price_point_name: + # type: string + # examples: + # application/json: + # product: + # id: 3861800 + # name: Trial Product + # handle: trial-product + # description: Trial period with payment expected at end of trial. + # accounting_code: '' + # request_credit_card: true + # expiration_interval: null + # expiration_interval_unit: never + # created_at: '2016-07-08T09:53:55-04:00' + # updated_at: '2016-09-05T13:00:36-04:00' + # price_in_cents: 1000 + # interval: 1 + # interval_unit: month + # initial_charge_in_cents: null + # trial_price_in_cents: 0 + # trial_interval: 7 + # trial_interval_unit: day + # archived_at: null + # require_credit_card: true + # return_params: '' + # taxable: false + # update_return_url: '' + # initial_charge_after_trial: false + # version_number: 6 + # update_return_params: '' + # product_family: + # id: 527890 + # name: Acme Projects + # description: '' + # handle: billing-plans + # accounting_code: null + # public_signup_pages: + # - id: 294791 + # return_url: '' + # return_params: '' + # url: 'https://general-goods.chargify.com/subscribe/xv52yrcc3byx/trial-product' + # product_price_point_name: Default + # security: + # - <>: [] + # x-stoplight: + # id: GET_products-id-format + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # statusCode: 200 '/products/{product_id}/price_points.json': parameters: - name: product_id @@ -11517,8 +11511,8 @@ paths: description: 'When fetching a product''s price points, if you have defined multiple currencies at the site level, you can optionally pass the ?currency_prices=true query param to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.' type: boolean default: false - - $ref: '#/parameters/trait:pagination10:page' - - $ref: '#/parameters/trait:pagination10:per_page' + - $ref: '#/parameters/trait%3Apagination10%3Apage' + - $ref: '#/parameters/trait%3Apagination10%3Aper_page' responses: '200': description: '' @@ -12238,11 +12232,11 @@ paths: This method allows to retrieve a list of Product Families for a site. parameters: - - $ref: '#/parameters/trait:productFamilyQueryString:date_field' - - $ref: '#/parameters/trait:productFamilyQueryString:start_date' - - $ref: '#/parameters/trait:productFamilyQueryString:end_date' - - $ref: '#/parameters/trait:productFamilyQueryString:start_datetime' - - $ref: '#/parameters/trait:productFamilyQueryString:end_datetime' + - $ref: '#/parameters/trait%3AproductFamilyQueryString%3Adate_field' + - $ref: '#/parameters/trait%3AproductFamilyQueryString%3Astart_date' + - $ref: '#/parameters/trait%3AproductFamilyQueryString%3Aend_date' + - $ref: '#/parameters/trait%3AproductFamilyQueryString%3Astart_datetime' + - $ref: '#/parameters/trait%3AproductFamilyQueryString%3Aend_datetime' responses: '200': description: OK @@ -12770,8 +12764,8 @@ paths: This method gives a merchant the option to retrieve a list of all of the current churn codes for a given site. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -12847,7 +12841,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string security: - <>: [] x-stoplight: @@ -12890,7 +12884,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string security: - <>: [] x-stoplight: @@ -12923,7 +12917,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string security: - <>: [] x-stoplight: @@ -12946,7 +12940,7 @@ paths: Use this method to determine if the referral code is valid and applicable within your Site. parameters: - - $ref: '#/parameters/trait:referralCode:code' + - $ref: '#/parameters/trait%3AreferralCode%3Acode' responses: '200': description: '' @@ -13297,7 +13291,7 @@ paths: last_payment: type: string churn_date: - type: 'null' + type: string examples: application/json: id: 48 @@ -13385,7 +13379,7 @@ paths: This endpoint allows you to fetch some site data. #### Relationship invoicing enabled - If site has RI enabled then you will see more settings like: + If site has RI enabled then you will see more settings like: "customer_hierarchy_enabled": true, "whopays_enabled": true, @@ -13473,7 +13467,7 @@ paths: ## Read Statement IDs for a Subscription This method will return a list of Statement IDs associated with one subscription. Use the IDs returned here in conjunction with [Read/Show by Chargify ID](#endpoint:nyiRmzkvKSQNGa6Ag). - + ## Sorting examples Say you would like to get the 10 most recently created statements. You would specify the following optional parameters: @@ -13509,7 +13503,7 @@ paths: in: query description: 'This parameter indicates how many records to fetch in each request. Preset to 10,000.' type: number - - $ref: '#/parameters/trait:settledSinceUnix:settled_since' + - $ref: '#/parameters/trait%3AsettledSinceUnix%3Asettled_since' responses: '200': description: OK @@ -13558,9 +13552,9 @@ paths: description: 'This parameter indicates how many records to fetch in each request. Preset to 10,000.' required: false type: number - - $ref: '#/parameters/trait:statementsList:sort' - - $ref: '#/parameters/trait:statementsList:direction' - - $ref: '#/parameters/trait:settledSinceUnix:settled_since' + - $ref: '#/parameters/trait%3AstatementsList%3Asort' + - $ref: '#/parameters/trait%3AstatementsList%3Adirection' + - $ref: '#/parameters/trait%3AsettledSinceUnix%3Asettled_since' responses: '200': description: OK @@ -13602,10 +13596,10 @@ paths: This method will return the full HTML and content associated with a subscription on your Site. parameters: - - $ref: '#/parameters/trait:statementsList:sort' - - $ref: '#/parameters/trait:statementsList:direction' - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3AstatementsList%3Asort' + - $ref: '#/parameters/trait%3AstatementsList%3Adirection' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: '' @@ -13691,9 +13685,7 @@ paths: type: type: string kind: - type: - - 'null' - - string + type: string # nullable transaction_type: type: string success: @@ -13709,25 +13701,21 @@ paths: ending_balance_in_cents: type: integer gateway_used: - type: - - 'null' - - string + type: string # nullable gateway_transaction_id: - type: - - 'null' - - string + type: string # nullable gateway_order_id: - type: 'null' + type: string payment_id: - type: - - integer - - 'null' + allOf: + - type: integer #nullable + - type: string #nullable product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -13735,20 +13723,20 @@ paths: item_name: type: string original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: - - integer - - 'null' + allOf: + - type: integer #nullable + - type: string #nullable taxations: type: array items: type: object properties: tax_id: - type: 'null' + type: string tax_charge_id: type: integer tax_name: @@ -13763,7 +13751,7 @@ paths: type: object properties: tax_rule_id: - type: 'null' + type: string country_code: type: string subdivision_code: @@ -13801,16 +13789,12 @@ paths: created_at: type: string event_specific_data: - type: - - 'null' - - object + type: object properties: product_id: type: integer account_transaction_id: - type: - - integer - - 'null' + type: integer #nullable previous_subscription_state: type: string new_subscription_state: @@ -13866,7 +13850,7 @@ paths:
US
- + @@ -14052,7 +14036,7 @@ paths:
US
- + @@ -14250,11 +14234,11 @@ paths: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -14345,7 +14329,7 @@ paths:
US
- + @@ -14565,7 +14549,7 @@ paths:
US
- + @@ -14795,7 +14779,7 @@ paths: Date/Time Type Detail Amount ............ ..... ............................................... .......... - 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) + 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) 04:21PM EDT CCPay Amelia Example - Basic Plan: Renewal payment $42.50 ............ ..... ............................................... .......... Totals: $42.50 @@ -14805,26 +14789,26 @@ paths: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Subscription State Change - 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from - trialing to active + 10/24/2016 Subscription State Change + 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from + trialing to active ............ .................................................................. - 10/24/2016 Subscription Product Change + 10/24/2016 Subscription Product Change 04:20PM EDT Product changed on Amelia Example's subscription from 'Trial Produ - ct' to 'Basic Plan' + ct' to 'Basic Plan' ............ .................................................................. - 10/24/2016 Billing Date Change + 10/24/2016 Billing Date Change 04:21PM EDT Billing date changed on Amelia Example's subscription to Basic Pla - n from 10/31/2016 to 10/24/2016 + n from 10/31/2016 to 10/24/2016 ............ .................................................................. - 10/24/2016 Renewal Success + 10/24/2016 Renewal Success 04:21PM EDT Successful renewal for Amelia Example's subscription to Basic Plan ............ .................................................................. - 10/24/2016 Payment Success - 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to - Basic Plan + 10/24/2016 Payment Success + 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to + Basic Plan ............ .................................................................. We thank you for your continued business! @@ -14986,10 +14970,10 @@ paths: - name: '' in: query type: string - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:statementsList:sort' - - $ref: '#/parameters/trait:statementsList:direction' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AstatementsList%3Asort' + - $ref: '#/parameters/trait%3AstatementsList%3Adirection' responses: '200': description: '' @@ -15075,9 +15059,7 @@ paths: type: type: string kind: - type: - - 'null' - - string + type: string # nullable transaction_type: type: string success: @@ -15093,25 +15075,20 @@ paths: ending_balance_in_cents: type: integer gateway_used: - type: - - 'null' - - string + type: string # nullable gateway_transaction_id: - type: - - 'null' - - string + type: string # nullable gateway_order_id: - type: 'null' + type: string payment_id: - type: - - integer - - 'null' + allOf: + - type: integer #nullable product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -15119,20 +15096,18 @@ paths: item_name: type: string original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: - - integer - - 'null' + type: integer #nullable taxations: type: array items: type: object properties: tax_id: - type: 'null' + type: string tax_charge_id: type: integer tax_name: @@ -15147,7 +15122,7 @@ paths: type: object properties: tax_rule_id: - type: 'null' + type: string country_code: type: string subdivision_code: @@ -15185,16 +15160,12 @@ paths: created_at: type: string event_specific_data: - type: - - 'null' - - object + type: object properties: product_id: type: integer account_transaction_id: - type: - - integer - - 'null' + type: integer #nullable previous_subscription_state: type: string new_subscription_state: @@ -15250,7 +15221,7 @@ paths:
US
- + @@ -15436,7 +15407,7 @@ paths:
US
- + @@ -15634,11 +15605,11 @@ paths: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -15729,7 +15700,7 @@ paths:
US
- + @@ -15949,7 +15920,7 @@ paths:
US
- + @@ -16179,7 +16150,7 @@ paths: Date/Time Type Detail Amount ............ ..... ............................................... .......... - 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) + 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) 04:21PM EDT CCPay Amelia Example - Basic Plan: Renewal payment $42.50 ............ ..... ............................................... .......... Totals: $42.50 @@ -16189,26 +16160,26 @@ paths: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Subscription State Change - 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from - trialing to active + 10/24/2016 Subscription State Change + 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from + trialing to active ............ .................................................................. - 10/24/2016 Subscription Product Change + 10/24/2016 Subscription Product Change 04:20PM EDT Product changed on Amelia Example's subscription from 'Trial Produ - ct' to 'Basic Plan' + ct' to 'Basic Plan' ............ .................................................................. - 10/24/2016 Billing Date Change + 10/24/2016 Billing Date Change 04:21PM EDT Billing date changed on Amelia Example's subscription to Basic Pla - n from 10/31/2016 to 10/24/2016 + n from 10/31/2016 to 10/24/2016 ............ .................................................................. - 10/24/2016 Renewal Success + 10/24/2016 Renewal Success 04:21PM EDT Successful renewal for Amelia Example's subscription to Basic Plan ............ .................................................................. - 10/24/2016 Payment Success - 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to - Basic Plan + 10/24/2016 Payment Success + 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to + Basic Plan ............ .................................................................. We thank you for your continued business! @@ -16432,7 +16403,7 @@ paths:
US
- + @@ -16618,7 +16589,7 @@ paths:
US
- + @@ -16816,11 +16787,11 @@ paths: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -17607,124 +17578,125 @@ paths: mock: enabled: false statusCode: 200 - '/subscriptions/{subscription_group_uid}/payment_profiles/{payment_profile_id}/change_payment_profile.json': - parameters: - - name: subscription_group_uid - in: path - required: true - type: string - - name: payment_profile_id - in: path - required: true - type: string - post: - operationId: POST_subscriptions-subscription_group_uid-payment_profiles-payment_profile_id-change_payment_profile-json - summary: Change Default Payment Profile - tags: - - Subscription Groups - description: |- - ## Change Default Payment Profile for Subscription Group - - This will change the default payment profile on the subscription group to the existing payment profile with the id specified. - - You must elect to change the existing payment profile to a new payment profile ID in order to receive a satisfactory response from this endpoint. - The new payment profile must belong to the subscription group's customer, otherwise you will receive an error. - responses: - '200': - description: '' - schema: - type: object - properties: - payment_profile: - type: object - properties: - id: - type: integer - first_name: - type: string - last_name: - type: string - masked_card_number: - type: string - card_type: - type: string - expiration_month: - type: integer - expiration_year: - type: integer - customer_id: - type: integer - current_vault: - type: 'null' - vault_token: - type: 'null' - billing_address: - type: 'null' - billing_city: - type: 'null' - billing_state: - type: 'null' - billing_zip: - type: 'null' - billing_country: - type: 'null' - customer_vault_token: - type: 'null' - billing_address_2: - type: 'null' - site_gateway_setting_id: - type: 'null' - payment_type: - type: string - disabled: - type: boolean - examples: - application/json: - payment_profile: - id: 3 - first_name: Leland - last_name: Considine - masked_card_number: XXXX-XXXX-XXXX-1 - card_type: bogus - expiration_month: 12 - expiration_year: 2022 - customer_id: 1 - current_vault: null - vault_token: null - billing_address: null - billing_city: null - billing_state: null - billing_zip: null - billing_country: null - customer_vault_token: null - billing_address_2: null - site_gateway_setting_id: null - payment_type: credit_card - disabled: false - '422': - description: '' - schema: - type: object - properties: - errors: - type: array - items: - type: string - examples: - application/json: - errors: - - Cannot switch to a payment profile outside of the group - security: - - <>: [] - x-stoplight: - id: POST_subscriptions-subscriptiongroupuid-paymentprofiles-paymentprofileid-changepaymentprofilejson - beforeScript: null - afterScript: null - public: true - mock: - enabled: false - dynamic: false - statusCode: 200 + # duplicate of by subscription id + # '/subscriptions/{subscription_group_uid}/payment_profiles/{payment_profile_id}/change_payment_profile.json': + # parameters: + # - name: subscription_group_uid + # in: path + # required: true + # type: string + # - name: payment_profile_id + # in: path + # required: true + # type: string + # post: + # operationId: POST_subscriptions-subscription_group_uid-payment_profiles-payment_profile_id-change_payment_profile-json + # summary: Change Default Payment Profile + # tags: + # - Subscription Groups + # description: |- + # ## Change Default Payment Profile for Subscription Group + # + # This will change the default payment profile on the subscription group to the existing payment profile with the id specified. + # + # You must elect to change the existing payment profile to a new payment profile ID in order to receive a satisfactory response from this endpoint. + # The new payment profile must belong to the subscription group's customer, otherwise you will receive an error. + # responses: + # '200': + # description: '' + # schema: + # type: object + # properties: + # payment_profile: + # type: object + # properties: + # id: + # type: integer + # first_name: + # type: string + # last_name: + # type: string + # masked_card_number: + # type: string + # card_type: + # type: string + # expiration_month: + # type: integer + # expiration_year: + # type: integer + # customer_id: + # type: integer + # current_vault: + # type: string + # vault_token: + # type: string + # billing_address: + # type: string + # billing_city: + # type: string + # billing_state: + # type: string + # billing_zip: + # type: string + # billing_country: + # type: string + # customer_vault_token: + # type: string + # billing_address_2: + # type: string + # site_gateway_setting_id: + # type: string + # payment_type: + # type: string + # disabled: + # type: boolean + # examples: + # application/json: + # payment_profile: + # id: 3 + # first_name: Leland + # last_name: Considine + # masked_card_number: XXXX-XXXX-XXXX-1 + # card_type: bogus + # expiration_month: 12 + # expiration_year: 2022 + # customer_id: 1 + # current_vault: null + # vault_token: null + # billing_address: null + # billing_city: null + # billing_state: null + # billing_zip: null + # billing_country: null + # customer_vault_token: null + # billing_address_2: null + # site_gateway_setting_id: null + # payment_type: credit_card + # disabled: false + # '422': + # description: '' + # schema: + # type: object + # properties: + # errors: + # type: array + # items: + # type: string + # examples: + # application/json: + # errors: + # - Cannot switch to a payment profile outside of the group + # security: + # - <>: [] + # x-stoplight: + # id: POST_subscriptions-subscriptiongroupuid-paymentprofiles-paymentprofileid-changepaymentprofilejson + # beforeScript: null + # afterScript: null + # public: true + # mock: + # enabled: false + # dynamic: false + # statusCode: 200 '/subscription_groups/{uid}/cancel.json': parameters: - name: uid @@ -18040,9 +18012,9 @@ paths: errors: type: array items: - type: - - string - - array + allOf: + - type: string + - type: array items: type: string examples: @@ -18237,33 +18209,25 @@ paths: next_assessment_at: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string expires_at: - type: 'null' + type: string created_at: type: string updated_at: type: string cancellation_message: - type: - - 'null' - - string + type: string cancellation_method: - type: - - 'null' - - string + type: string cancel_at_end_of_period: - type: - - boolean - - 'null' + type: boolean #nullable canceled_at: - type: - - 'null' - - string + type: string current_period_started_at: type: string previous_state: @@ -18273,17 +18237,15 @@ paths: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: - - 'null' - - string + type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string reason_code: - type: 'null' + type: string receives_invoice_emails: type: boolean net_terms: @@ -18302,7 +18264,7 @@ paths: organization: type: string reference: - type: 'null' + type: string id: type: integer created_at: @@ -18334,7 +18296,7 @@ paths: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string tax_exempt: type: boolean vat_number: @@ -18359,15 +18321,15 @@ paths: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string initial_charge_after_trial: @@ -18383,7 +18345,7 @@ paths: updated_at: type: string archived_at: - type: 'null' + type: string update_return_url: type: string update_return_params: @@ -18398,7 +18360,7 @@ paths: handle: type: string accounting_code: - type: 'null' + type: string description: type: string public_signup_pages: @@ -18428,21 +18390,13 @@ paths: last_name: type: string masked_card_number: - type: - - 'null' - - string + type: string card_type: - type: - - 'null' - - string + type: string expiration_month: - type: - - integer - - 'null' + type: integer #nullable expiration_year: - type: - - integer - - 'null' + type: integer #nullable billing_address: type: string billing_address_2: @@ -18450,9 +18404,7 @@ paths: billing_city: type: string billing_state: - type: - - 'null' - - string + type: string billing_country: type: string billing_zip: @@ -18462,7 +18414,7 @@ paths: vault_token: type: string customer_vault_token: - type: 'null' + type: string customer_id: type: integer payment_type: @@ -18470,27 +18422,17 @@ paths: referral_code: type: string next_product_id: - type: 'null' + type: string coupon_use_count: - type: - - integer - - 'null' + type: integer #nullable coupon_uses_allowed: - type: - - integer - - 'null' + type: integer #nullable next_product_handle: - type: - - string - - 'null' + type: string stored_credential_transaction_id: - type: - - integer - - 'null' + type: integer #nullable on_hold_at: - type: - - string - - 'null' + type: string scheduled_cancellation_at: type: string prepaid_dunning: @@ -18675,7 +18617,7 @@ paths: ## Server Response - When you update the `next_billing` timestamp through the `PUT` method, the server response will not return data under the key/value pair of `next_billing`. + When you update the `next_billing` timestamp through the `PUT` method, the server response will not return data under the key/value pair of `next_billing`. Please view the key/value pair of `current_period_ends_at` to verify that the `next_billing` date has been changed successfully. @@ -19472,7 +19414,7 @@ paths: ## Coupon Application Warning - Sending this request will overwrite all (single and multiple) coupons previously applied to the subscription. + Sending this request will overwrite all (single and multiple) coupons previously applied to the subscription. If you want to apply stackable coupons, **remove** any coupons you have and use [request with 'codes' parameter](#endpoint:DbA9MDLykDkNbYCaJ). parameters: @@ -19633,9 +19575,9 @@ paths: description: |- ## Remove the Coupon from the Subscription Response - If the Coupon is successfully removed, the string will be returned. + If the Coupon is successfully removed, the string will be returned. - ```Coupon succesfully removed``` + ```Coupon succesfully removed``` Otherwise, the "422 Unprocessable Entity" error will be returned. @@ -19681,14 +19623,14 @@ paths: Passing `group` parameters with a `target` containing a `type` and optional `id` is all that's needed. When the `target` parameter specifies a `"customer"` or `"subscription"` that is already part of a hierarchy, the subscription will become a member of the customer's subscription group. If the target customer or subscription is not part of a subscription group, a new group will be created and the subscription will become part of the group with the specified target customer set as the responsible payer for the group's subscriptions. - Rather than specifying a customer, the `target` parameter could instead simply have a value of + Rather than specifying a customer, the `target` parameter could instead simply have a value of * `"self"` which indicates the subscription will be paid for not by some other customer, but by the subscribing customer, * `"parent"` which indicates the subscription will be paid for by the subscribing customer's parent within a customer hierarchy, or - * `"eldest"` which indicates the subscription will be paid for by the root-level customer in the subscribing customer's hierarchy. + * `"eldest"` which indicates the subscription will be paid for by the root-level customer in the subscribing customer's hierarchy. The optional `billing` parameters specify how some aspects of the billing for the new subscription should be handled. Rather than capturing payment immediately, the `accrue` parameter can be included so that the new subscription charges accrue until the next assessment date. Regarding the date, the `align_date` parameter can be included so that the billing date of the new subscription matches up with the default subscription group in the customer hierarchy. When choosing to align the dates, the `prorate` parameter can also be specified so that the new subscription charges are prorated based on the billing period of the default subscription group in the customer hierarchy also. - ### Group Attributes + ### Group Attributes | target | Attributes of the target customer who will be the responsible payer of the created subscription. Required. | |---------|-------------------------------------------------------------------------------------------------------------| @@ -19805,7 +19747,7 @@ paths: Resume a paused (on-hold) subscription. If the normal next renewal date has not passed, the subscription will return to active and will renew on that date. Otherwise, it will behave like a reactivation, setting the billing date to 'now' and charging the subscriber. parameters: - - $ref: '#/parameters/trait:calendarBillingTrait:calendar_billing[''resumption_charge'']' + - $ref: '#/parameters/trait%3AcalendarBillingTrait%3Acalendar_billing%5B%27%27resumption_charge%27%27%5D' responses: '200': description: '' @@ -20454,7 +20396,7 @@ paths: due_date: type: string paid_date: - type: 'null' + type: string status: type: string collection_method: @@ -20466,11 +20408,11 @@ paths: consolidation_level: type: string parent_invoice_uid: - type: 'null' + type: string parent_invoice_number: - type: 'null' + type: string group_primary_subscription_id: - type: 'null' + type: string product_name: type: string product_family_name: @@ -20486,17 +20428,17 @@ paths: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: type: string customer: @@ -20509,45 +20451,45 @@ paths: last_name: type: string organization: - type: 'null' + type: string email: type: string vat_number: - type: 'null' + type: string reference: - type: 'null' + type: string memo: type: string billing_address: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string shipping_address: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string subtotal_amount: type: string discount_amount: @@ -20594,15 +20536,15 @@ paths: period_range_end: type: string product_id: - type: 'null' + type: string product_version: - type: 'null' + type: string product_price_point_id: - type: 'null' + type: string component_id: - type: 'null' + type: string price_point_id: - type: 'null' + type: string discounts: type: array items: @@ -21476,7 +21418,7 @@ paths: ### Invalid Current Period Starts At - 422 Unprocessable Entity - When passing `current_period_starts_at` some validations are made: + When passing `current_period_starts_at` some validations are made: 1) The subscription needs to be unbilled (no statements or invoices). 2) The value passed must be a valid date/time. @@ -21545,7 +21487,7 @@ paths: - Payment - 'Subscriptions: Prepayments' description: |- - ## Create Prepayment + ## Create Prepayment In order to specify a prepayment made against a subcription, specify the `amount, memo, details, method`. @@ -21587,7 +21529,7 @@ paths: type: string method: type: string - enum: '[check","cash","money_order","ach","paypal_account","credit_card_on_file","other"]' + enum: ["check","cash","money_order","ach","paypal_account","credit_card_on_file","other"] payment_profile_id: type: integer required: @@ -21666,11 +21608,11 @@ paths: ### Results - The resulting charges upon reactivation will be: - + 1 charge for $20 for the new product + The resulting charges upon reactivation will be: + + 1 charge for $20 for the new product + 1 charge for $20 for the balance due + Total charges = $40 - + + The subscription will transition to active + The subscription balance will be zero responses: @@ -21783,9 +21725,9 @@ paths: type: object properties: component_id: - type: - - string - - integer + allOf: + - type: string + - type: integer description: |- The component to include in the preview, identified by either its official Chargify ID _or_ its handle. @@ -21814,9 +21756,9 @@ paths: * The desired `unit_balance` for a metered component * The desired metric quantity for an events-based component price_point_id: - type: - - string - - integer + allOf: + - type: string + - type: integer description: |- An optional identifier for the price point to use in computing the billing preview. This value may be provided either as an official Chargify ID or the price point's handle. If no value is provided, the subscription's current price point for the component is used (which may be the default price point if none has been specified on the subscription). @@ -22071,15 +22013,15 @@ paths: In the above example, 1567 is derived by adding 1 to the “last” ID you received from the first request. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:txnKinds:kinds' - - $ref: '#/parameters/trait:txnSinceId:since_id' - - $ref: '#/parameters/trait:txnMaxId:max_id' - - $ref: '#/parameters/trait:txnSinceDate:since_date' - - $ref: '#/parameters/trait:txnUntilDate:until_date' - - $ref: '#/parameters/trait:txnDirection:direction' - - $ref: '#/parameters/trait:txnOrderBy:order_by' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AtxnKinds%3Akinds' + - $ref: '#/parameters/trait%3AtxnSinceId%3Asince_id' + - $ref: '#/parameters/trait%3AtxnMaxId%3Amax_id' + - $ref: '#/parameters/trait%3AtxnSinceDate%3Asince_date' + - $ref: '#/parameters/trait%3AtxnUntilDate%3Auntil_date' + - $ref: '#/parameters/trait%3AtxnDirection%3Adirection' + - $ref: '#/parameters/trait%3AtxnOrderBy%3Aorder_by' responses: '200': description: OK @@ -22183,8 +22125,8 @@ paths: description: optionally include the response from the gateway if the transaction is a payment type: boolean default: false - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' responses: '200': description: OK @@ -22255,14 +22197,14 @@ paths: The sort order is based on the `created_at` timestamp and cannot be changed. parameters: - - $ref: '#/parameters/trait:pagination20:page' - - $ref: '#/parameters/trait:pagination20:per_page' - - $ref: '#/parameters/trait:txnKinds:kinds' - - $ref: '#/parameters/trait:txnSinceId:since_id' - - $ref: '#/parameters/trait:txnMaxId:max_id' - - $ref: '#/parameters/trait:txnSinceDate:since_date' - - $ref: '#/parameters/trait:txnUntilDate:until_date' - - $ref: '#/parameters/trait:txnDirection:direction' + - $ref: '#/parameters/trait%3Apagination20%3Apage' + - $ref: '#/parameters/trait%3Apagination20%3Aper_page' + - $ref: '#/parameters/trait%3AtxnKinds%3Akinds' + - $ref: '#/parameters/trait%3AtxnSinceId%3Asince_id' + - $ref: '#/parameters/trait%3AtxnMaxId%3Amax_id' + - $ref: '#/parameters/trait%3AtxnSinceDate%3Asince_date' + - $ref: '#/parameters/trait%3AtxnUntilDate%3Auntil_date' + - $ref: '#/parameters/trait%3AtxnDirection%3Adirection' responses: '200': description: '' @@ -22589,7 +22531,7 @@ paths: The Chargify API allows you to create an endpoint and assign a list of webhooks subscriptions (events) to it. - You can check available events here. + You can check available events here. [Event keys](https://help.chargify.com/webhooks/webhooks-reference.html#example-payloads) parameters: - name: body @@ -22743,7 +22685,7 @@ paths: You can update an Endpoint via the API with a PUT request to the resource endpoint. - You can change the `url` of your endpoint which consumes webhooks or list of `webhook_subscriptions`. + You can change the `url` of your endpoint which consumes webhooks or list of `webhook_subscriptions`. Check available [Event keys](https://help.chargify.com/webhooks/webhooks-reference.html). Always send a complete list of events which you want subscribe/watch. @@ -22806,7 +22748,7 @@ paths: '404': description: '' schema: - type: 'null' + type: string '422': description: '' schema: @@ -23674,9 +23616,7 @@ definitions: tax_in_cents: type: integer accounting_code: - type: - - 'null' - - string + type: string kind: type: string item_type: @@ -23737,7 +23677,7 @@ definitions: amount_in_cents: type: integer kind: - type: 'null' + type: string description: type: string payment_method: @@ -23962,7 +23902,7 @@ definitions: last_error_at: type: string accepted_at: - type: 'null' + type: string last_sent_at: type: string last_sent_url: @@ -24057,9 +23997,7 @@ definitions: created_at: type: string event_specific_data: - type: - - 'null' - - object + type: object properties: previous_subscription_state: type: string @@ -24190,7 +24128,7 @@ definitions: description: type: string amount_in_cents: - type: 'null' + type: string product_family_id: type: integer product_family_name: @@ -24202,21 +24140,21 @@ definitions: start_date: type: string end_date: - type: 'null' + type: string percentage: type: number duration_period_count: - type: 'null' + type: string duration_interval: - type: 'null' + type: string duration_interval_unit: - type: 'null' + type: string allow_negative_balance: type: boolean archived_at: - type: 'null' + type: string conversion_limit: - type: 'null' + type: string stackable: type: boolean compounding_strategy: @@ -24263,9 +24201,9 @@ definitions: type: object properties: quantity: - type: - - integer - - number + allOf: + - type: integer + - type: number description: 'The allocated quantity to which to set the line-items allocated quantity. By default, this is an integer. If decimal allocations are enabled for the component, it will be a decimal number. For On/Off components, use 1for on and 0 for off.' memo: type: string @@ -24296,10 +24234,9 @@ definitions: type: integer description: (required for the multiple allocations endpoint) The id associated with the component for which the allocation is being made price_point_id: - type: - - string - - integer - - 'null' + allOf: + - type: string + - type: integer description: 'Price point that the allocation should be charged at. Accepts either the price point''s id (integer) or handle (string). When not specified, the default price point will be used.' required: - quantity @@ -24362,9 +24299,9 @@ definitions: type: string maxLength: 255 amount_in_cents: - type: - - integer - - string + allOf: + - type: integer + - type: string minimum: -99999999999 maximum: 99999999999 ending_balance_in_cents: @@ -24389,16 +24326,12 @@ definitions: type: string format: date-time payment_id: - type: 'null' + type: string period_range_start: - type: - - string - - 'null' + type: string format: date period_range_end: - type: - - string - - 'null' + type: string format: date example: adjustment: @@ -24439,7 +24372,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -24453,17 +24386,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: - - integer - - 'null' + type: integer #nullable trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -24490,7 +24421,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -24499,9 +24430,7 @@ definitions: id: type: integer return_url: - type: - - 'null' - - string + type: string return_params: type: string url: @@ -24734,9 +24663,7 @@ definitions: type: string description: The type of credit to be created if the change in cost is a downgrade. payment: - type: - - object - - 'null' + type: object description: 'Information for captured payment, if applicable' properties: id: @@ -24791,7 +24718,7 @@ definitions: type: string maxLength: 255 reference: - type: 'null' + type: string id: type: integer minimum: 1 @@ -24829,11 +24756,9 @@ definitions: type: string format: date-time portal_invite_last_sent_at: - type: - - 'null' - - string + type: string #nullable portal_invite_last_accepted_at: - type: 'null' + type: string example: customer: first_name: John @@ -24936,7 +24861,7 @@ definitions: unit_price: type: integer component: - type: 'null' + type: string upgrade_charge: type: string downgrade_credit: @@ -25096,19 +25021,19 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: type: integer product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -25116,14 +25041,10 @@ definitions: item_name: type: string period_range_start: - type: - - 'null' - - string + type: string #nullable format: date period_range_end: - type: - - 'null' - - string + type: string #nullable format: date original_amount_in_cents: type: integer @@ -25132,16 +25053,16 @@ definitions: taxable_amount_in_cents: type: integer price_point_id: - type: 'null' + type: string price_point_handle: - type: 'null' + type: string taxations: type: array items: type: object properties: tax_id: - type: 'null' + type: string tax_charge_id: type: integer tax_name: @@ -25156,7 +25077,7 @@ definitions: type: object properties: tax_rule_id: - type: 'null' + type: string country_code: type: string subdivision_code: @@ -25280,14 +25201,10 @@ definitions: taxable: type: string period_range_start: - type: - - string - - 'null' + type: string format: date period_range_end: - type: - - string - - 'null' + type: string format: date example: charge: @@ -25314,14 +25231,10 @@ definitions: memo: type: string period_range_start: - type: - - string - - 'null' + type: string format: date period_range_end: - type: - - string - - 'null' + type: string format: date example: adjustment: @@ -25343,14 +25256,10 @@ definitions: memo: type: string period_range_start: - type: - - string - - 'null' + type: string format: date period_range_end: - type: - - string - - 'null' + type: string format: date required: - amount @@ -25423,42 +25332,38 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: type: integer original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: 'null' + type: string taxations: type: array items: type: object period_range_start: - type: - - string - - 'null' + type: string #nullable format: date period_range_end: - type: - - string - - 'null' + type: string #nullable format: date example: charge: @@ -25504,7 +25409,7 @@ definitions: type: type: string kind: - type: 'null' + type: string transaction_type: type: string success: @@ -25520,32 +25425,28 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: type: integer period_range_start: - type: - - string - - 'null' + type: string #nullable format: date period_range_end: - type: - - string - - 'null' + type: string #nullable format: date example: adjustment: @@ -25703,9 +25604,9 @@ definitions: type: object properties: quantity: - type: - - integer - - number + allOf: + - type: integer + - type: number description: integer by default or decimal number if fractional quantities are enabled for the component price_point_id: type: string @@ -25930,29 +25831,29 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: type: integer card_number: - type: 'null' + type: string card_expiration: - type: 'null' + type: string card_type: - type: 'null' + type: string refunded_amount_in_cents: type: integer example: @@ -26093,9 +25994,9 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string required: @@ -26170,7 +26071,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -26178,19 +26079,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -26200,9 +26101,9 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: 'null' + type: string total_revenue_in_cents: type: integer product_price_in_cents: @@ -26214,9 +26115,9 @@ definitions: referral_code: type: string coupon_use_count: - type: 'null' + type: string coupon_uses_allowed: - type: 'null' + type: string customer: type: object properties: @@ -26227,7 +26128,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string created_at: @@ -26235,31 +26136,31 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: - type: 'null' + type: string address_2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: type: string portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: type: string cc_emails: - type: 'null' + type: string product: type: object properties: @@ -26276,7 +26177,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -26290,7 +26191,7 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: type: integer trial_interval: @@ -26298,7 +26199,7 @@ definitions: trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -26325,7 +26226,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -26373,7 +26274,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string payment_type: @@ -26522,7 +26423,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string bank_name: @@ -26580,7 +26481,7 @@ definitions: last_name: type: string masked_card_number: - type: 'null' + type: string card_type: type: string expiration_month: @@ -26604,9 +26505,9 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string example: @@ -26683,7 +26584,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string payment_type: @@ -26755,7 +26656,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -26769,7 +26670,7 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string '': type: integer trial_interval: @@ -26777,7 +26678,7 @@ definitions: trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -26804,7 +26705,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -26977,7 +26878,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string example: product_family: id: 933860 @@ -27022,9 +26923,9 @@ definitions: type: object properties: component_id: - type: - - integer - - string + allOf: + - type: integer + - type: string description: 'integer or string prefixed with "handle:"' price_point_id: type: integer @@ -27068,7 +26969,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string example: product_family: id: 527890 @@ -27101,9 +27002,9 @@ definitions: type: boolean description: Deprecated value that can be ignored unless you have legacy hosted pages expiration_interval: - type: 'null' + type: string expiration_interval_unit: - type: 'null' + type: string created_at: type: string updated_at: @@ -27115,29 +27016,29 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: - type: 'null' + type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: - type: 'null' + type: string taxable: type: boolean update_return_url: - type: 'null' + type: string initial_charge_after_trial: type: boolean version_number: type: integer update_return_params: - type: 'null' + type: string product_family: type: object properties: @@ -27150,7 +27051,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -27159,9 +27060,9 @@ definitions: id: type: integer return_url: - type: 'null' + type: string return_params: - type: 'null' + type: string url: type: string product_price_point_name: @@ -27235,9 +27136,9 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: - type: 'null' + type: string created_at: type: string updated_at: @@ -27249,29 +27150,29 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: - type: 'null' + type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: - type: 'null' + type: string taxable: type: boolean update_return_url: - type: 'null' + type: string initial_charge_after_trial: type: boolean version_number: type: integer update_return_params: - type: 'null' + type: string product_family: type: object properties: @@ -27284,7 +27185,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -27293,9 +27194,9 @@ definitions: id: type: integer return_url: - type: 'null' + type: string return_params: - type: 'null' + type: string url: type: string request_billing_address: @@ -27440,19 +27341,19 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -27544,7 +27445,7 @@ definitions: type: type: string kind: - type: 'null' + type: string transaction_type: type: string success: @@ -27562,17 +27463,17 @@ definitions: gateway_used: type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: type: integer product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -27698,9 +27599,7 @@ definitions: type: type: string kind: - type: - - 'null' - - string + type: string #nullable transaction_type: type: string success: @@ -27716,25 +27615,19 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: - - 'null' - - string + type: string #nullable gateway_transaction_id: - type: - - 'null' - - string + type: string #nullable gateway_order_id: - type: 'null' + type: string payment_id: - type: - - integer - - 'null' + type: integer #nullable product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -27742,20 +27635,18 @@ definitions: item_name: type: string original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: - - integer - - 'null' + type: integer #nullable taxations: type: array items: type: object properties: tax_id: - type: 'null' + type: string tax_charge_id: type: integer tax_name: @@ -27770,7 +27661,7 @@ definitions: type: object properties: tax_rule_id: - type: 'null' + type: string country_code: type: string subdivision_code: @@ -27808,16 +27699,14 @@ definitions: created_at: type: string event_specific_data: - type: - - 'null' - - object + type: object #nullable properties: product_id: type: integer account_transaction_id: - type: - - integer - - 'null' + allOf: + - type: integer #nullable + - type: string #nullable previous_subscription_state: type: string new_subscription_state: @@ -27872,7 +27761,7 @@ definitions:
US
- + @@ -28058,7 +27947,7 @@ definitions:
US
- + @@ -28256,11 +28145,11 @@ definitions: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -28351,7 +28240,7 @@ definitions:
US
- + @@ -28571,7 +28460,7 @@ definitions:
US
- + @@ -28801,7 +28690,7 @@ definitions: Date/Time Type Detail Amount ............ ..... ............................................... .......... - 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) + 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) 04:21PM EDT CCPay Amelia Example - Basic Plan: Renewal payment $42.50 ............ ..... ............................................... .......... Totals: $42.50 @@ -28811,26 +28700,26 @@ definitions: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Subscription State Change - 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from - trialing to active + 10/24/2016 Subscription State Change + 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from + trialing to active ............ .................................................................. - 10/24/2016 Subscription Product Change + 10/24/2016 Subscription Product Change 04:20PM EDT Product changed on Amelia Example's subscription from 'Trial Produ - ct' to 'Basic Plan' + ct' to 'Basic Plan' ............ .................................................................. - 10/24/2016 Billing Date Change + 10/24/2016 Billing Date Change 04:21PM EDT Billing date changed on Amelia Example's subscription to Basic Pla - n from 10/31/2016 to 10/24/2016 + n from 10/31/2016 to 10/24/2016 ............ .................................................................. - 10/24/2016 Renewal Success + 10/24/2016 Renewal Success 04:21PM EDT Successful renewal for Amelia Example's subscription to Basic Plan ............ .................................................................. - 10/24/2016 Payment Success - 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to - Basic Plan + 10/24/2016 Payment Success + 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to + Basic Plan ............ .................................................................. We thank you for your continued business! @@ -29066,19 +28955,19 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -29086,11 +28975,11 @@ definitions: item_name: type: string original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: 'null' + type: string taxations: type: array items: @@ -29119,7 +29008,7 @@ definitions: product_id: type: integer account_transaction_id: - type: 'null' + type: string example: statement: id: 79221109 @@ -29170,7 +29059,7 @@ definitions:
US
- + @@ -29356,7 +29245,7 @@ definitions:
US
- + @@ -29554,11 +29443,11 @@ definitions: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -29795,7 +29684,7 @@ definitions: organization: type: string reference: - type: 'null' + type: string address: type: string address_2: @@ -29836,13 +29725,13 @@ definitions: card_type: type: string expiration_month: - type: - - integer - - string + allOf: + - type: integer + - type: string expiration_year: - type: - - integer - - string + allOf: + - type: integer + - type: string billing_address: type: string billing_address_2: @@ -29850,7 +29739,7 @@ definitions: billing_city: type: string billing_state: - type: 'null' + type: string billing_country: type: string billing_zip: @@ -30032,25 +29921,25 @@ definitions: next_assessment_at: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string expires_at: - type: 'null' + type: string created_at: type: string updated_at: type: string cancellation_message: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string cancel_at_end_of_period: - type: 'null' + type: string canceled_at: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -30060,15 +29949,15 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string reason_code: - type: 'null' + type: string receives_invoice_emails: type: boolean net_terms: @@ -30089,7 +29978,7 @@ definitions: organization: type: string reference: - type: 'null' + type: string id: type: integer created_at: @@ -30117,7 +30006,7 @@ definitions: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string tax_exempt: type: boolean vat_number: @@ -30142,15 +30031,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string initial_charge_after_trial: @@ -30166,7 +30055,7 @@ definitions: updated_at: type: string archived_at: - type: 'null' + type: string update_return_url: type: string update_return_params: @@ -30181,7 +30070,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string description: type: string public_signup_pages: @@ -30225,7 +30114,7 @@ definitions: billing_city: type: string billing_state: - type: 'null' + type: string billing_country: type: string billing_zip: @@ -30235,7 +30124,7 @@ definitions: vault_token: type: string customer_vault_token: - type: 'null' + type: string customer_id: type: integer payment_type: @@ -30243,7 +30132,7 @@ definitions: referral_code: type: string next_product_id: - type: 'null' + type: string coupon_use_count: type: integer coupon_uses_allowed: @@ -30251,9 +30140,9 @@ definitions: stored_credential_transaction_id: type: integer next_product_handle: - type: 'null' + type: string on_hold_at: - type: 'null' + type: string scheduled_cancellation_at: type: string prepaid_dunning: @@ -30413,9 +30302,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -30423,7 +30312,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -30431,19 +30320,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: - type: 'null' + type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -30453,9 +30342,9 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: 'null' + type: string total_revenue_in_cents: type: integer product_price_in_cents: @@ -30467,9 +30356,9 @@ definitions: referral_code: type: string coupon_use_count: - type: 'null' + type: string coupon_uses_allowed: - type: 'null' + type: string customer: type: object properties: @@ -30490,29 +30379,29 @@ definitions: reference: type: string address: - type: 'null' + type: string address_2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: - type: 'null' + type: string portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: type: string cc_emails: - type: 'null' + type: string product: type: object properties: @@ -30529,7 +30418,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -30543,15 +30432,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -30578,7 +30467,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -30616,19 +30505,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: - type: 'null' + type: string billing_country: - type: 'null' + type: string customer_vault_token: type: string billing_address_2: - type: 'null' + type: string payment_type: type: string payer_id: @@ -30794,7 +30683,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string payment_type: @@ -30857,25 +30746,25 @@ definitions: gateway_transaction_id: type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: type: integer item_name: - type: 'null' + type: string parent_id: - type: 'null' + type: string role: - type: 'null' + type: string card_number: type: string card_expiration: @@ -30896,17 +30785,11 @@ definitions: type: object description: 'the gateway response for a single payment, only if requested in the query string. not available when listing multiple transactions for a site.' component_handle: - type: - - string - - 'null' + type: string #nullable component_price_point_id: - type: - - integer - - 'null' + type: integer #nullable component_price_point_handle: - type: - - string - - 'null' + type: string #nullable example: transaction: id: 237759849 @@ -31076,9 +30959,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -31086,7 +30969,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -31094,19 +30977,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: - type: 'null' + type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -31116,7 +30999,7 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string total_revenue_in_cents: @@ -31132,7 +31015,7 @@ definitions: coupon_use_count: type: integer coupon_uses_allowed: - type: 'null' + type: string customer: type: object properties: @@ -31143,7 +31026,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string created_at: @@ -31151,31 +31034,31 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: - type: 'null' + type: string address_2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: - type: 'null' + type: string portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -31194,7 +31077,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -31208,15 +31091,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -31243,7 +31126,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -31281,19 +31164,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: - type: 'null' + type: string billing_country: - type: 'null' + type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string payer_id: @@ -31438,19 +31321,13 @@ definitions: type: integer description: Number of times the coupon has been applied savings: - type: - - number - - 'null' + type: number #nullable description: Dollar amount of customer savings as a result of the coupon. savings_in_cents: - type: - - number - - 'null' + type: number #nullable description: Dollar amount of customer savings as a result of the coupon. revenue: - type: - - number - - 'null' + type: number #nullable description: Total revenue of the all subscriptions that have received a discount from this coupon. revenue_in_cents: type: number @@ -31546,7 +31423,7 @@ definitions: description: type: string amount_in_cents: - type: 'null' + type: string product_family_id: type: integer created_at: @@ -31556,15 +31433,13 @@ definitions: start_date: type: string end_date: - type: 'null' + type: string percentage: - type: - - string - - 'null' + type: string #nullable recurring: type: boolean duration_period_count: - type: 'null' + type: string duration_interval: type: integer duration_interval_unit: @@ -31572,7 +31447,7 @@ definitions: allow_negative_balance: type: boolean archived_at: - type: 'null' + type: string conversion_limit: type: integer stackable: @@ -31766,29 +31641,29 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: 'null' + type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string payment_id: - type: 'null' + type: string product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: type: integer card_number: - type: 'null' + type: string card_expiration: - type: 'null' + type: string card_type: - type: 'null' + type: string refunded_amount_in_cents: type: integer example: @@ -31879,25 +31754,25 @@ definitions: next_assessment_at: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string expires_at: - type: 'null' + type: string created_at: type: string updated_at: type: string cancellation_message: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string cancel_at_end_of_period: type: boolean canceled_at: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -31907,13 +31782,13 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: 'null' + type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string customer: type: object properties: @@ -31928,7 +31803,7 @@ definitions: organization: type: string reference: - type: 'null' + type: string id: type: integer created_at: @@ -31956,16 +31831,14 @@ definitions: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string tax_exempt: type: boolean vat_number: type: string description: The VAT number for the customer. parent_id: - type: - - integer - - 'null' + type: integer #nullable product: type: object properties: @@ -31986,15 +31859,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string initial_charge_after_trial: @@ -32010,7 +31883,7 @@ definitions: updated_at: type: string archived_at: - type: 'null' + type: string update_return_url: type: string update_return_params: @@ -32025,7 +31898,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string description: type: string public_signup_pages: @@ -32077,7 +31950,7 @@ definitions: vault_token: type: string customer_vault_token: - type: 'null' + type: string customer_id: type: integer payment_type: @@ -32085,11 +31958,11 @@ definitions: referral_code: type: string next_product_id: - type: 'null' + type: string coupon_use_count: - type: 'null' + type: string coupon_uses_allowed: - type: 'null' + type: string example: - subscription: id: 14950975 @@ -32344,7 +32217,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string bank_name: @@ -32437,9 +32310,9 @@ definitions: type: object properties: component_id: - type: - - integer - - string + allOf: + - type: integer + - type: string default: 'integer or string prefixed with "handle:"' unit_balance: type: integer @@ -32547,9 +32420,7 @@ definitions: type: type: string kind: - type: - - 'null' - - string + type: string #nullable transaction_type: type: string success: @@ -32565,25 +32436,19 @@ definitions: ending_balance_in_cents: type: integer gateway_used: - type: - - 'null' - - string + type: string #nullable gateway_transaction_id: - type: - - 'null' - - string + type: string #nullable gateway_order_id: - type: 'null' + type: string payment_id: - type: - - integer - - 'null' + type: integer #nullable product_id: type: integer tax_id: - type: 'null' + type: string component_id: - type: 'null' + type: string statement_id: type: integer customer_id: @@ -32591,20 +32456,18 @@ definitions: item_name: type: string original_amount_in_cents: - type: 'null' + type: string discount_amount_in_cents: - type: 'null' + type: string taxable_amount_in_cents: - type: - - integer - - 'null' + type: integer #nullable taxations: type: array items: type: object properties: tax_id: - type: 'null' + type: string tax_charge_id: type: integer tax_name: @@ -32619,7 +32482,7 @@ definitions: type: object properties: tax_rule_id: - type: 'null' + type: string country_code: type: string subdivision_code: @@ -32657,16 +32520,14 @@ definitions: created_at: type: string event_specific_data: - type: - - 'null' - - object + type: object #nullable properties: product_id: type: integer account_transaction_id: - type: - - integer - - 'null' + allOf: + - type: integer #nullable + - type: string #nullable previous_subscription_state: type: string new_subscription_state: @@ -32721,7 +32582,7 @@ definitions:
US
- + @@ -32907,7 +32768,7 @@ definitions:
US
- + @@ -33105,11 +32966,11 @@ definitions: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Signup Success + 10/24/2016 Signup Success 04:20PM EDT Successful signup for Amelia Example's subscription to Trial Produ - ct + ct ............ .................................................................. We thank you for your continued business! @@ -33200,227 +33061,227 @@ definitions:
US
- - - - - -

Summary

-
-
- Date: - 10/24/2016 -
-
- Billing Date: - 10/24/2016 -
- -
-
- Starting Balance: - $0.00 -
-
- Current Charges: - $42.50 -
-
- Payments: - $42.50 -
-
- Ending Balance: - $0.00 -
-
-
-
- Balance Paid: - 10/24/2016 04:21PM EDT -
-
- PAID -
-
-
- - - - - -

Detail

-
-
-

Current Charges and Adjustments

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Date/TimeTypeDetailCharge
10/24/2016 04:21PM EDTRecurringBasic Plan (10/24/2016 - 11/24/2016)$40.00
10/24/2016 04:21PM EDTTaxMA Tax (6.25%)$2.50
Totals$42.50
-
- -
-

Payments

- - - - - - - - - - - - - - - - - - - - - -
Date/TimeTypeDetailAmount
10/24/2016 04:21PM EDTCC Payment -
Amelia Example - Basic Plan: Renewal payment
- XXXX-XXXX-XXXX-1 bogus (01/2026) - 		- $42.50 -
Totals$42.50
-
- - -
- - - - - -

Period Activity

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Date/TimeEventDetail
10/24/2016 04:20PM EDTSubscription State ChangeState changed on Amelia Example's subscription to Basic Plan from trialing to active
10/24/2016 04:20PM EDTSubscription Product ChangeProduct changed on Amelia Example's subscription from 'Trial Product' to 'Basic Plan'
10/24/2016 04:21PM EDTBilling Date ChangeBilling date changed on Amelia Example's subscription to Basic Plan from 10/31/2016 to 10/24/2016
10/24/2016 04:21PM EDTRenewal SuccessSuccessful renewal for Amelia Example's subscription to Basic Plan
10/24/2016 04:21PM EDTPayment SuccessSuccessful payment of $42.50 for Amelia Example's subscription to Basic Plan
-
- - - - - -

We thank you for your continued business!

- - - - - closed_at: '2016-10-24T16:21:13-04:00' - created_at: '2016-10-24T16:21:12-04:00' - customer_billing_address: 123 Anywhere Street - customer_billing_address_2: '' - customer_billing_city: Anywhere - customer_billing_country: US - customer_billing_state: MA - customer_billing_zip: '02120' - customer_first_name: Amelia - customer_last_name: Example - customer_organization: '' - customer_shipping_address: 123 Anywhere Street - customer_shipping_address_2: '' - customer_shipping_city: Anywhere - customer_shipping_country: US - customer_shipping_state: MA - customer_shipping_zip: '02120' - ending_balance_in_cents: 0 - future_payments: [] - html_view: | -
-
-

Account Information

-
-
Amelia Example
- -
555-555-1212
- -
-

Shipping Address

-
123 Anywhere Street
-
- Anywhere, - MA - 02120 -
-
US
-
- -
-

Billing Address

-
123 Anywhere Street
-
- Anywhere, - MA - 02120 -
-
US
-
- +
+ + + +

Summary

+
+
+ Date: + 10/24/2016 +
+
+ Billing Date: + 10/24/2016 +
+ +
+
+ Starting Balance: + $0.00 +
+
+ Current Charges: + $42.50 +
+
+ Payments: + $42.50 +
+
+ Ending Balance: + $0.00 +
+
+ +
+
+ Balance Paid: + 10/24/2016 04:21PM EDT +
+
+ PAID +
+
+
+ + + + + +

Detail

+
+
+

Current Charges and Adjustments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Date/TimeTypeDetailCharge
10/24/2016 04:21PM EDTRecurringBasic Plan (10/24/2016 - 11/24/2016)$40.00
10/24/2016 04:21PM EDTTaxMA Tax (6.25%)$2.50
Totals$42.50
+
+ +
+

Payments

+ + + + + + + + + + + + + + + + + + + + + +
Date/TimeTypeDetailAmount
10/24/2016 04:21PM EDTCC Payment +
Amelia Example - Basic Plan: Renewal payment
+ XXXX-XXXX-XXXX-1 bogus (01/2026) + 		+ $42.50 +
Totals$42.50
+
+ + +
+ + + + + +

Period Activity

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Date/TimeEventDetail
10/24/2016 04:20PM EDTSubscription State ChangeState changed on Amelia Example's subscription to Basic Plan from trialing to active
10/24/2016 04:20PM EDTSubscription Product ChangeProduct changed on Amelia Example's subscription from 'Trial Product' to 'Basic Plan'
10/24/2016 04:21PM EDTBilling Date ChangeBilling date changed on Amelia Example's subscription to Basic Plan from 10/31/2016 to 10/24/2016
10/24/2016 04:21PM EDTRenewal SuccessSuccessful renewal for Amelia Example's subscription to Basic Plan
10/24/2016 04:21PM EDTPayment SuccessSuccessful payment of $42.50 for Amelia Example's subscription to Basic Plan
+
+ + + + + +

We thank you for your continued business!

+ + + + + closed_at: '2016-10-24T16:21:13-04:00' + created_at: '2016-10-24T16:21:12-04:00' + customer_billing_address: 123 Anywhere Street + customer_billing_address_2: '' + customer_billing_city: Anywhere + customer_billing_country: US + customer_billing_state: MA + customer_billing_zip: '02120' + customer_first_name: Amelia + customer_last_name: Example + customer_organization: '' + customer_shipping_address: 123 Anywhere Street + customer_shipping_address_2: '' + customer_shipping_city: Anywhere + customer_shipping_country: US + customer_shipping_state: MA + customer_shipping_zip: '02120' + ending_balance_in_cents: 0 + future_payments: [] + html_view: | +
+
+

Account Information

+
+
Amelia Example
+ +
555-555-1212
+ +
+

Shipping Address

+
123 Anywhere Street
+
+ Anywhere, + MA + 02120 +
+
US
+
+ +
+

Billing Address

+
123 Anywhere Street
+
+ Anywhere, + MA + 02120 +
+
US
+
+
@@ -33650,7 +33511,7 @@ definitions: Date/Time Type Detail Amount ............ ..... ............................................... .......... - 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) + 10/24/2016 XXXX-XXXX-XXXX-1 bogus (01/2026) 04:21PM EDT CCPay Amelia Example - Basic Plan: Renewal payment $42.50 ............ ..... ............................................... .......... Totals: $42.50 @@ -33660,26 +33521,26 @@ definitions: Period Activity --------------- - Date/Time Event/Details + Date/Time Event/Details ............ .................................................................. - 10/24/2016 Subscription State Change - 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from - trialing to active + 10/24/2016 Subscription State Change + 04:20PM EDT State changed on Amelia Example's subscription to Basic Plan from + trialing to active ............ .................................................................. - 10/24/2016 Subscription Product Change + 10/24/2016 Subscription Product Change 04:20PM EDT Product changed on Amelia Example's subscription from 'Trial Produ - ct' to 'Basic Plan' + ct' to 'Basic Plan' ............ .................................................................. - 10/24/2016 Billing Date Change + 10/24/2016 Billing Date Change 04:21PM EDT Billing date changed on Amelia Example's subscription to Basic Pla - n from 10/31/2016 to 10/24/2016 + n from 10/31/2016 to 10/24/2016 ............ .................................................................. - 10/24/2016 Renewal Success + 10/24/2016 Renewal Success 04:21PM EDT Successful renewal for Amelia Example's subscription to Basic Plan ............ .................................................................. - 10/24/2016 Payment Success - 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to - Basic Plan + 10/24/2016 Payment Success + 04:21PM EDT Successful payment of $42.50 for Amelia Example's subscription to + Basic Plan ............ .................................................................. We thank you for your continued business! @@ -33964,9 +33825,7 @@ definitions: code: type: string description: - type: - - 'null' - - string + type: string #nullable position: type: integer created_at: @@ -34058,7 +33917,7 @@ definitions: billing_country: type: string billing_address_2: - type: 'null' + type: string example: payment_profile: first_name: Graham @@ -34148,7 +34007,7 @@ definitions: handle: type: string archived_at: - type: 'null' + type: string created_at: type: string updated_at: @@ -34165,9 +34024,7 @@ definitions: starting_quantity: type: integer ending_quantity: - type: - - integer - - 'null' + type: integer # nullable unit_price: type: string use_site_exchange_rate: @@ -34279,7 +34136,7 @@ definitions: handle: type: string archived_at: - type: 'null' + type: string created_at: type: string updated_at: @@ -34296,7 +34153,7 @@ definitions: starting_quantity: type: integer ending_quantity: - type: 'null' + type: string unit_price: type: string example: @@ -34441,9 +34298,9 @@ definitions: component_id: type: integer price_point: - type: - - integer - - string + allOf: + - type: integer + - type: string example: components: - component_id: 997 @@ -34571,9 +34428,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -34581,7 +34438,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -34589,19 +34446,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -34611,7 +34468,7 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string total_revenue_in_cents: @@ -34623,15 +34480,15 @@ definitions: payment_type: type: string referral_code: - type: 'null' + type: string coupon_use_count: type: integer coupon_uses_allowed: type: integer reason_code: - type: 'null' + type: string automatically_resume_at: - type: 'null' + type: string coupon_codes: type: array items: @@ -34654,7 +34511,7 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: type: string address_2: @@ -34670,15 +34527,15 @@ definitions: phone: type: string portal_invite_last_sent_at: - type: 'null' + type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: - type: 'null' + type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -34693,13 +34550,13 @@ definitions: description: type: string accounting_code: - type: 'null' + type: string request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: - type: 'null' + type: string created_at: type: string updated_at: @@ -34711,31 +34568,31 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: - type: 'null' + type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: - type: 'null' + type: string taxable: type: boolean update_return_url: - type: 'null' + type: string tax_code: - type: 'null' + type: string initial_charge_after_trial: type: boolean version_number: type: integer update_return_params: - type: 'null' + type: string product_family: type: object properties: @@ -34744,11 +34601,11 @@ definitions: name: type: string description: - type: 'null' + type: string handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -34787,7 +34644,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string payment_type: @@ -34923,9 +34780,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -34933,7 +34790,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -34941,19 +34798,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: - type: 'null' + type: string payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -34963,7 +34820,7 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string total_revenue_in_cents: @@ -34975,17 +34832,15 @@ definitions: payment_type: type: string referral_code: - type: - - 'null' - - string + type: string #nullable coupon_use_count: type: integer coupon_uses_allowed: type: integer reason_code: - type: 'null' + type: string automatically_resume_at: - type: 'null' + type: string coupon_codes: type: array items: @@ -35000,7 +34855,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string created_at: @@ -35008,31 +34863,31 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: - type: 'null' + type: string address_2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: - type: 'null' + type: string portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -35051,7 +34906,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -35065,15 +34920,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -35102,7 +34957,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -35111,7 +34966,7 @@ definitions: id: type: integer return_url: - type: 'null' + type: string return_params: type: string url: @@ -35140,19 +34995,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: - type: 'null' + type: string billing_country: - type: 'null' + type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string payer_id: @@ -35350,9 +35205,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -35360,7 +35215,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -35368,19 +35223,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -35390,9 +35245,9 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: 'null' + type: string total_revenue_in_cents: type: integer product_price_in_cents: @@ -35404,11 +35259,11 @@ definitions: referral_code: type: string coupon_use_count: - type: 'null' + type: string coupon_uses_allowed: - type: 'null' + type: string reason_code: - type: 'null' + type: string automatically_resume_at: type: string coupon_codes: @@ -35433,7 +35288,7 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: type: string address_2: @@ -35451,13 +35306,13 @@ definitions: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: - type: 'null' + type: string portal_customer_created_at: type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -35476,7 +35331,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -35490,15 +35345,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -35527,7 +35382,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -35566,7 +35421,7 @@ definitions: billing_country: type: string customer_vault_token: - type: 'null' + type: string billing_address_2: type: string payment_type: @@ -35763,9 +35618,9 @@ definitions: type: object properties: '': - type: - - string - - array + allOf: + - type: string + - type: array items: {} product_price_point_name: type: string @@ -35829,7 +35684,7 @@ definitions: name: type: string handle: - type: 'null' + type: string description: type: string accounting_code: @@ -35837,7 +35692,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -35851,7 +35706,7 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: type: integer trial_interval: @@ -35888,7 +35743,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -36147,14 +36002,11 @@ definitions: receives_invoice_emails: type: boolean net_terms: - type: - - integer - - string - - 'null' + allOf: + - type: integer + - type: string stored_credential_transaction_id: - type: - - integer - - 'null' + type: integer #nullable example: subscription: next_billing_at: '2010-08-06T15:34:00Z' @@ -36234,9 +36086,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -36244,7 +36096,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -36252,19 +36104,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -36274,7 +36126,7 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string total_revenue_in_cents: @@ -36292,9 +36144,9 @@ definitions: coupon_uses_allowed: type: integer reason_code: - type: 'null' + type: string automatically_resume_at: - type: 'null' + type: string coupon_codes: type: array items: @@ -36317,7 +36169,7 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: type: string address_2: @@ -36335,7 +36187,7 @@ definitions: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: @@ -36360,7 +36212,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -36382,7 +36234,7 @@ definitions: trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -36411,7 +36263,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -36449,19 +36301,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: type: string billing_country: - type: 'null' + type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string payer_id: @@ -36858,13 +36710,13 @@ definitions: See also the [invoice consolidation documentation](https://help.chargify.com/invoices/consolidation.html). parent_invoice_uid: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `child`, this specifies the UID of the parent (consolidated) invoice.' parent_invoice_number: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `child`, this specifies the number of the parent (consolidated) invoice.' group_primary_subscription_id: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `parent`, this specifies the ID of the subscription which was the primary subscription of the subscription group that generated the invoice.' product_name: type: string @@ -36882,17 +36734,17 @@ definitions: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: type: string '': @@ -36908,7 +36760,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string memo: @@ -37052,19 +36904,13 @@ definitions: type: integer description: The version of the product subscribed when the charge was made. component_id: - type: - - integer - - 'null' + type: integer #nullable description: The ID of the component being billed. Will be `nil` for non-component charges. price_point_id: - type: - - integer - - 'null' + type: integer #nullable description: The price point ID of the component being billed. Will be `nil` for non-component charges. product_price_point_id: - type: - - 'null' - - integer + type: integer #nullable description: The price point ID of the line item's product discounts: type: array @@ -37165,9 +37011,7 @@ definitions: applied_amount: type: string gateway_transaction_id: - type: - - string - - 'null' + type: string #nullable description: The transaction ID for the refund as returned from the payment gateway payments: type: array @@ -37206,9 +37050,7 @@ definitions: prepayment: type: boolean gateway_transaction_id: - type: - - string - - 'null' + type: string #nullable description: The transaction ID for the payment as returned from the payment gateway custom_fields: type: array @@ -37491,7 +37333,7 @@ definitions: updated_at: type: string archived_at: - type: 'null' + type: string offer_items: type: array items: @@ -37615,7 +37457,7 @@ definitions: updated_at: type: string archived_at: - type: 'null' + type: string offer_items: type: array items: @@ -37932,9 +37774,9 @@ definitions: state: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string created_at: @@ -37942,7 +37784,7 @@ definitions: updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -37950,19 +37792,19 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -37972,7 +37814,7 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: type: string total_revenue_in_cents: @@ -37990,9 +37832,9 @@ definitions: coupon_uses_allowed: type: integer reason_code: - type: 'null' + type: string automatically_resume_at: - type: 'null' + type: string coupon_codes: type: array items: @@ -38017,7 +37859,7 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: type: string address_2: @@ -38033,17 +37875,17 @@ definitions: phone: type: string portal_invite_last_sent_at: - type: 'null' + type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: - type: 'null' + type: string portal_customer_created_at: type: string vat_number: - type: 'null' + type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -38054,7 +37896,7 @@ definitions: name: type: string handle: - type: 'null' + type: string description: type: string accounting_code: @@ -38062,7 +37904,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -38076,15 +37918,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -38113,7 +37955,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -38122,7 +37964,7 @@ definitions: id: type: integer return_url: - type: 'null' + type: string return_params: type: string url: @@ -38151,19 +37993,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: - type: 'null' + type: string billing_country: - type: 'null' + type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string payer_id: @@ -38348,7 +38190,7 @@ definitions: address: type: string address_2: - type: 'null' + type: string city: type: string state: @@ -38427,7 +38269,7 @@ definitions: tax_amount_in_cents: type: integer description: - type: 'null' + type: string total_in_cents: type: integer total_discount_in_cents: @@ -38550,7 +38392,7 @@ definitions: address: type: string address_2: - type: 'null' + type: string city: type: string state: @@ -38606,7 +38448,7 @@ definitions: type: object properties: tax_id: - type: 'null' + type: string tax_name: type: string rate: @@ -39145,13 +38987,13 @@ definitions: See also the [invoice consolidation documentation](https://help.chargify.com/invoices/consolidation.html). parent_invoice_uid: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `child`, this specifies the UID of the parent (consolidated) invoice.' parent_invoice_number: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `child`, this specifies the number of the parent (consolidated) invoice.' group_primary_subscription_id: - type: 'null' + type: string description: 'For invoices with `consolidation_level` of `parent`, this specifies the ID of the subscription which was the primary subscription of the subscription group that generated the invoice.' product_name: type: string @@ -39169,17 +39011,17 @@ definitions: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: type: string '': @@ -39195,7 +39037,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string memo: @@ -39339,19 +39181,13 @@ definitions: type: integer description: The version of the product subscribed when the charge was made. component_id: - type: - - integer - - 'null' + type: integer #nullable description: The ID of the component being billed. Will be `nil` for non-component charges. price_point_id: - type: - - integer - - 'null' + type: integer #nullable description: The price point ID of the component being billed. Will be `nil` for non-component charges. product_price_point_id: - type: - - 'null' - - integer + type: integer #nullable description: The price point ID of the line item's product. discounts: type: array @@ -39452,9 +39288,7 @@ definitions: applied_amount: type: string gateway_transaction_id: - type: - - string - - 'null' + type: string #nullable description: The transaction ID for the refund as returned from the payment gateway payments: type: array @@ -39493,9 +39327,7 @@ definitions: prepayment: type: boolean gateway_transaction_id: - type: - - string - - 'null' + type: string #nullable description: The transaction ID for the payment as returned from the payment gateway custom_fields: type: array @@ -39822,9 +39654,7 @@ definitions: type: string description: The coupon description. This will be displayed to the customers after the coupon validation. amount_in_cents: - type: - - integer - - 'null' + type: integer #nullable description: The amount in cents of the discount of the coupon. product_family_id: type: integer @@ -39842,15 +39672,11 @@ definitions: description: The start date of the coupon format: date-time end_date: - type: - - 'null' - - string + type: string #nullable description: The expiration date of the coupon format: date-time percentage: - type: - - 'null' - - string + type: string #nullable description: 'The discount percentage. Should be an integer between 1 and 100. You should set the percentage or the amount, but not both.' minimum: 1 maximum: 100 @@ -39858,32 +39684,26 @@ definitions: type: boolean description: 'If true, the discount will be applied at signup and every renewal (for the number of renewals given by duration_period_count). Otherwise, discount will be applied only at signup.' duration_period_count: - type: - - number - - integer - - 'null' + allOf: + - type: number + - type: integer + - type: string description: Number of renewals the coupon is good for. Recurring should be set to true. Setting recurring to true and leaving this blank indicates that the coupon applies indefinitely. duration_interval: - type: - - 'null' - - integer + type: integer #nullable description: Integer used to measure the interval unit. duration_interval_unit: - type: - - 'null' - - string + type: string #nullable description: Description of the number of days/months the coupon should be applied. allow_negative_balance: type: boolean description: 'Boolean. If true, credits will carry forward to next billing. Otherwise discount may not exceed total of the charges.' archived_at: - type: - - 'null' - - string + type: string #nullable description: Timestamp indicating when this coupon was archived format: date-time conversion_limit: - type: 'null' + type: string description: Number of times this coupon (or any of its codes) may be added to a subscription stackable: type: boolean @@ -40234,33 +40054,25 @@ definitions: next_assessment_at: type: string trial_started_at: - type: 'null' + type: string trial_ended_at: - type: 'null' + type: string activated_at: type: string expires_at: - type: 'null' + type: string created_at: type: string updated_at: type: string cancellation_message: - type: - - 'null' - - string + type: string #nullable cancellation_method: - type: - - 'null' - - string + type: string #nullable cancel_at_end_of_period: - type: - - boolean - - 'null' + type: boolean #nullable canceled_at: - type: - - 'null' - - string + type: string #nullable current_period_started_at: type: string previous_state: @@ -40270,15 +40082,13 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: - - 'null' - - string + type: string #nullable payment_collection_method: type: string snap_day: - type: 'null' + type: string customer: type: object properties: @@ -40289,13 +40099,11 @@ definitions: email: type: string cc_emails: - type: - - 'null' - - string + type: string #nullable organization: type: string reference: - type: 'null' + type: string id: type: integer created_at: @@ -40323,15 +40131,13 @@ definitions: portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string tax_exempt: type: boolean vat_number: type: string parent_id: - type: - - integer - - 'null' + type: integer #nullable product: type: object properties: @@ -40352,15 +40158,15 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string trial_price_in_cents: - type: 'null' + type: string trial_interval: - type: 'null' + type: string trial_interval_unit: type: string initial_charge_after_trial: @@ -40376,7 +40182,7 @@ definitions: updated_at: type: string archived_at: - type: 'null' + type: string update_return_url: type: string update_return_params: @@ -40391,7 +40197,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string description: type: string public_signup_pages: @@ -40419,21 +40225,13 @@ definitions: last_name: type: string masked_card_number: - type: - - 'null' - - string + type: string #nullable card_type: - type: - - 'null' - - string + type: string #nullable expiration_month: - type: - - integer - - 'null' + type: integer #nullable expiration_year: - type: - - integer - - 'null' + type: integer #nullable billing_address: type: string billing_address_2: @@ -40441,9 +40239,7 @@ definitions: billing_city: type: string billing_state: - type: - - 'null' - - string + type: string #nullable billing_country: type: string billing_zip: @@ -40453,7 +40249,7 @@ definitions: vault_token: type: string customer_vault_token: - type: 'null' + type: string customer_id: type: integer payment_type: @@ -40461,31 +40257,21 @@ definitions: referral_code: type: string next_product_id: - type: 'null' + type: string coupon_use_count: - type: - - integer - - 'null' + type: integer #nullable coupon_uses_allowed: - type: - - integer - - 'null' + type: integer #nullable payer_id: type: integer stored_credential_transaction_id: - type: - - integer - - 'null' + type: integer #nullable next_product_handle: - type: - - string - - 'null' + type: string #nullable currency: type: string scheduled_cancellation_at: - type: - - string - - 'null' + type: string #nullable prepaid_dunning: type: boolean example: @@ -40811,7 +40597,7 @@ definitions: email: type: string reference: - type: 'null' + type: string billing_address: type: object description: The billing address of the credit subscription. @@ -40932,14 +40718,10 @@ definitions: type: integer description: The version of the product being credited. component_id: - type: - - integer - - 'null' + type: integer #nullable description: The ID of the component being credited. Will be `nil` for non-component credits. price_point_id: - type: - - integer - - 'null' + type: integer #nullable description: The price point ID of the component being credited. Will be `nil` for non-component credits. discounts: type: array @@ -41415,13 +41197,13 @@ definitions: trial_ended_at: type: string activated_at: - type: 'null' + type: string created_at: type: string updated_at: type: string expires_at: - type: 'null' + type: string balance_in_cents: type: integer current_period_ends_at: @@ -41429,21 +41211,21 @@ definitions: next_assessment_at: type: string canceled_at: - type: 'null' + type: string cancellation_message: - type: 'null' + type: string next_product_id: - type: 'null' + type: string cancel_at_end_of_period: type: boolean payment_collection_method: type: string snap_day: - type: 'null' + type: string cancellation_method: - type: 'null' + type: string receives_invoice_emails: - type: 'null' + type: string current_period_started_at: type: string previous_state: @@ -41453,9 +41235,9 @@ definitions: signup_revenue: type: string delayed_cancel_at: - type: 'null' + type: string coupon_code: - type: 'null' + type: string total_revenue_in_cents: type: integer product_price_in_cents: @@ -41465,15 +41247,15 @@ definitions: payment_type: type: string referral_code: - type: 'null' + type: string coupon_use_count: - type: 'null' + type: string coupon_uses_allowed: - type: 'null' + type: string reason_code: - type: 'null' + type: string automatically_resume_at: - type: 'null' + type: string coupon_codes: type: array items: @@ -41490,7 +41272,7 @@ definitions: last_name: type: string organization: - type: 'null' + type: string email: type: string created_at: @@ -41498,33 +41280,33 @@ definitions: updated_at: type: string reference: - type: 'null' + type: string address: - type: 'null' + type: string address_2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: - type: 'null' + type: string portal_invite_last_sent_at: type: string portal_invite_last_accepted_at: - type: 'null' + type: string verified: type: boolean portal_customer_created_at: type: string vat_number: - type: 'null' + type: string cc_emails: - type: 'null' + type: string tax_exempt: type: boolean product: @@ -41543,7 +41325,7 @@ definitions: request_credit_card: type: boolean expiration_interval: - type: 'null' + type: string expiration_interval_unit: type: string created_at: @@ -41557,7 +41339,7 @@ definitions: interval_unit: type: string initial_charge_in_cents: - type: 'null' + type: string trial_price_in_cents: type: integer trial_interval: @@ -41565,7 +41347,7 @@ definitions: trial_interval_unit: type: string archived_at: - type: 'null' + type: string require_credit_card: type: boolean return_params: @@ -41594,7 +41376,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string public_signup_pages: type: array items: @@ -41603,7 +41385,7 @@ definitions: id: type: integer return_url: - type: 'null' + type: string return_params: type: string url: @@ -41632,19 +41414,19 @@ definitions: vault_token: type: string billing_address: - type: 'null' + type: string billing_city: - type: 'null' + type: string billing_state: - type: 'null' + type: string billing_zip: - type: 'null' + type: string billing_country: - type: 'null' + type: string customer_vault_token: - type: 'null' + type: string billing_address_2: - type: 'null' + type: string payment_type: type: string disabled: @@ -41791,7 +41573,7 @@ definitions: handle: type: string accounting_code: - type: 'null' + type: string example: product_family: id: 527890 @@ -42196,17 +41978,17 @@ definitions: type: object properties: street: - type: 'null' + type: string line2: - type: 'null' + type: string city: - type: 'null' + type: string state: - type: 'null' + type: string zip: - type: 'null' + type: string country: - type: 'null' + type: string phone: type: string customer: @@ -42223,9 +42005,9 @@ definitions: email: type: string vat_number: - type: 'null' + type: string reference: - type: 'null' + type: string memo: type: string billing_address: @@ -42310,9 +42092,9 @@ definitions: product_price_point_id: type: integer component_id: - type: 'null' + type: string price_point_id: - type: 'null' + type: string discounts: type: array items: @@ -42435,19 +42217,13 @@ definitions: type: string description: The email address of the customer cc_emails: - type: - - string - - 'null' + type: string #nullable description: '(Optional) A comma-separated list of emails that should be cc’d on all customer communications (i.e. “joe@example.com, sue@example.com”)' organization: - type: - - string - - 'null' + type: string #nullable description: The organization of the customer reference: - type: - - string - - 'null' + type: string #nullable description: The unique identifier used within your own application for this customer id: type: integer @@ -42459,81 +42235,53 @@ definitions: type: string description: The timestamp in which the customer object was last edited address: - type: - - string - - 'null' + type: string #nullable description: The customer’s shipping street address (i.e. “123 Main St.”) address_2: - type: - - string - - 'null' + type: string #nullable description: Second line of the customer’s shipping address i.e. “Apt. 100” city: - type: - - string - - 'null' + type: string #nullable description: The customer’s shipping address city (i.e. “Boston”) state: - type: - - string - - 'null' + type: string #nullable description: The customer’s shipping address state (i.e. “MA”) state_name: - type: - - string - - 'null' + type: string #nullable description: The customer's full name of state zip: - type: - - string - - 'null' + type: string #nullable description: The customer’s shipping address zip code (i.e. “12345”) country: - type: - - string - - 'null' + type: string #nullable description: "\tThe customer shipping address country" country_name: - type: - - string - - 'null' + type: string #nullable description: The customer's full name of country phone: - type: - - string - - 'null' + type: string #nullable description: The phone number of the customer verified: type: boolean description: Is the customer verified to use ACH as a payment method. Available only on Authorize.Net gateway portal_customer_created_at: - type: - - string - - 'null' + type: string #nullable description: The timestamp of when the Billing Portal entry was created at for the customer portal_invite_last_sent_at: - type: - - string - - 'null' + type: string #nullable description: The timestamp of when the Billing Portal invite was last sent at portal_invite_last_accepted_at: description: The timestamp of when the Billing Portal invite was last accepted - type: - - string - - 'null' + type: string #nullable tax_exempt: type: boolean description: (Optional) The tax exempt status for the customer. Acceptable values are true or 1 for true and false or 0 for false. vat_number: - type: - - string - - 'null' + type: string #nullable description: '(Optional) The VAT business identification number for the customer. This number is used to determine VAT tax opt out rules. It is not validated when added or updated on a customer record. Instead, it is validated via VIES before calculating taxes. Only valid business identification numbers will allow for VAT opt out.' parent_id: description: (Optional) The parent ID in Chargify if applicable. Parent is another Customer object. - type: - - integer - - 'null' + type: integer #nullable locale: type: string description: The locale for the customer to identify language-region @@ -42598,7 +42346,7 @@ definitions: type: integer description: The id of the Product Family to which the Component belongs price_per_unit_in_cents: - type: 'null' + type: string description: deprecated - use unit_price instead kind: type: string @@ -42631,19 +42379,13 @@ definitions: recurring: type: boolean upgrade_charge: - type: - - 'null' - - string + type: string #nullable downgrade_credit: - type: - - 'null' - - string + type: string #nullable created_at: type: string prices: - type: - - 'null' - - array + type: array # nullable description: 'An array of price brackets. If the component uses the ‘per_unit’ pricing scheme, this array will be empty.' items: type: object @@ -42655,7 +42397,7 @@ definitions: starting_quantity: type: integer ending_quantity: - type: 'null' + type: string unit_price: type: string price_point_id: @@ -42740,7 +42482,7 @@ definitions: input_type: type: string enum: - type: 'null' + type: string x-stoplight: id: metafield name: Metafield @@ -42773,9 +42515,7 @@ definitions: type: integer description: Gives the current invoice amount in the number of cents (ie. the sum of charges) paid_at: - type: - - string - - 'null' + type: string #nullable description: The date/time when the invoice was paid in full created_at: type: string @@ -42814,23 +42554,21 @@ definitions: id: type: integer payment_id: - type: - - integer - - 'null' + type: integer #nullable product_id: type: integer transaction_type: type: string gateway_transaction_id: - type: 'null' + type: string gateway_order_id: - type: 'null' + type: string starting_balance_in_cents: type: integer component_id: - type: 'null' + type: string tax_id: - type: 'null' + type: string customer_id: type: integer payments_and_credits: @@ -42858,9 +42596,7 @@ definitions: id: type: integer payment_id: - type: - - 'null' - - integer + type: integer #nullable product_id: type: integer transaction_type: @@ -42868,27 +42604,21 @@ definitions: gateway_transaction_id: type: string gateway_order_id: - type: 'null' + type: string starting_balance_in_cents: type: integer component_id: - type: 'null' + type: string tax_id: - type: 'null' + type: string customer_id: type: integer card_number: - type: - - string - - 'null' + type: string #nullable card_expiration: - type: - - string - - 'null' + type: string #nullable card_type: - type: - - string - - 'null' + type: string #nullable line_items: type: array items: @@ -42913,29 +42643,21 @@ definitions: id: type: integer payment_id: - type: - - 'null' - - integer + type: integer #nullable product_id: type: integer transaction_type: type: string gateway_transaction_id: - type: - - integer - - 'null' + type: integer #nullable gateway_order_id: - type: - - number - - 'null' + type: number #nullable starting_balance_in_cents: type: integer component_id: type: integer tax_id: - type: - - 'null' - - integer + type: integer #nullable customer_id: type: integer x-stoplight: @@ -42960,7 +42682,8 @@ definitions: id: chargify-js-key name: Chargify Js Key public: true -basePath: '%3C%3Csubdomain%3E%3E.chargify.com/' +basePath: '/' +host: 'subdomain.chargify.com' x-stoplight: beforeScript: '' afterScript: '' @@ -44305,9 +44028,9 @@ x-stoplight: We don’t want to block small bursts in usage. So instead of immediately rejecting your requests, we will slow and throttle them. If you see your responses coming in slower, do not parallelize your requests or try to make more concurrent requests to speed things up. You’ll only have to wait longer for your requests to get through. - If you have too many slowed requests, or your individual account queue gets too full with too many concurrent requests, you’ll likely receive an HTTP “429 Too Many Requests” response code with a message: + If you have too many slowed requests, or your individual account queue gets too full with too many concurrent requests, you’ll likely receive an HTTP “429 Too Many Requests” response code with a message: - `Your request was denied due to a usage violation. You can track this request with support by referencing …` + `Your request was denied due to a usage violation. You can track this request with support by referencing …` with a reference code. Please feel free to [contact support](https://chargify.zendesk.com/hc/en-us/requests/new) so we can help describe what happened and why the request was blocked. @@ -44329,7 +44052,7 @@ x-stoplight: ## Developer Portal - We've created a developer focused portal to give your organization a clear and quick overview of how to integrate with Chargify. + We've created a developer focused portal to give your organization a clear and quick overview of how to integrate with Chargify. The developer portal focuses on scenarios for integration and flow of events. We recommend familiarizing yourself with all of the content in the developer portal, as it's a great compliment to our API documentation. @@ -44341,7 +44064,7 @@ x-stoplight: ## Chargify.js - Our [Chargify.js documentation](https://developer.chargify.com/content/chargify-js/chargify-js.html) can be found under the developer portal. + Our [Chargify.js documentation](https://developer.chargify.com/content/chargify-js/chargify-js.html) can be found under the developer portal. Here you'll find an introduction to how Chargify.js allows you to tokenize sensitive information such as card numbers. Additionally, we cover some example implementations, as well as troubleshooting. @@ -44363,7 +44086,7 @@ x-stoplight: ## Support Access - Access to our Technical Specialist team for API support is currently limited to purchasers of our larger Chargify support plans. + Access to our Technical Specialist team for API support is currently limited to purchasers of our larger Chargify support plans. But don’t worry! There are quite a few options to help you get the answers you need: @@ -44561,7 +44284,7 @@ x-stoplight: ``` < Status: 409 Conflict {"errors":["DuplicatePrevention::DuplicateSubmissionError"]} - + ``` Unfortunately, it is not possible to know what the outcome of the first request was, so you cannot automatically assume it was successful. @@ -44585,7 +44308,7 @@ x-stoplight: ## Stats Documentation - There currently is not a complimentary matching set of documentation that compliments this endpoint. However, each Site's dashboard will reflect the summary of information provided in the Stats reposnse. + There currently is not a complimentary matching set of documentation that compliments this endpoint. However, each Site's dashboard will reflect the summary of information provided in the Stats reposnse. ``` https://subdomain.chargify.com/dashboard @@ -44694,7 +44417,7 @@ x-stoplight: content: |- ## Renewal Preview Intro - Renewal Preview is an object representing a subscription’s next assessment. You can retrieve it to see a snapshot of how much your customer will be charged on their next renewal. + Renewal Preview is an object representing a subscription’s next assessment. You can retrieve it to see a snapshot of how much your customer will be charged on their next renewal. ## Inclusion of Components @@ -44898,7 +44621,7 @@ x-stoplight: content: |- ## Migrations Intro - Chargify offers the ability to upgrade or downgrade a Customer’s subscription in the middle of a billing period, which is called a “Migration”. + Chargify offers the ability to upgrade or downgrade a Customer’s subscription in the middle of a billing period, which is called a “Migration”. ## Migrations Documentation @@ -44918,13 +44641,13 @@ x-stoplight: | include_trial | Boolean, default `0`. If `1` is sent the customer will migrate to the new product with a trial if one is available. If `0` is sent, the trial period will be ignored. | | include_initial_charge | Boolean, default 0. If 1 is sent initial charges will be assessed. If 0 is sent initial charges will be ignored. | | include_coupons | Boolean, default `1`. If `1` (or nothing) is sent, any coupons associated with the subscription will be applied to the migration. If `0` is sent, coupons will not be applied. | - | preserve_period | Boolean, default `0`. If `0` (or nothing) is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `1` is sent, the billing period will not change and a prorated charge will be issued for the new product. + | preserve_period | Boolean, default `0`. If `0` (or nothing) is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `1` is sent, the billing period will not change and a prorated charge will be issued for the new product. ## Alternate Request Body Options When using the migration endpoint, there are two alternative options you can use for your requests. - ### Use Handle + ### Use Handle You may elect to use `product_handle` instead of `product_id`, and `product_price_point_handle` instead of `product_price_point_id`: @@ -44968,7 +44691,7 @@ x-stoplight: id: product-family-intro name: Product Family Intro content: |- - ## Product Family Intro + ## Product Family Intro Product Families house your products, components and coupons. They can be used to categorize products, product levels or service offerings to your Subscribers. @@ -45090,7 +44813,7 @@ x-stoplight: | country | (Optional) The customer shipping address country, required in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format (i.e. “US”). | | phone | (Optional) The phone number of the customer. | | tax_exempt | (Optional) The tax_exempt status of the customer. Acceptable values are true or 1 for true and false or 0 for false. | - + ------------------ ## Payment Profile Attributes @@ -45196,13 +44919,13 @@ x-stoplight: ## External Refunds versus Refunds - It's important to note that 2 types of refunds can be created via the API. + It's important to note that 2 types of refunds can be created via the API. + [Refunds](#docTextSection:PdfZnp5bXtPjCr7Qg) interact with the Merchant's gateway and return funds directly to the Subscriber's bank. - + External refunds log a refund against the Subscriber's entry in Chargify. No funds are returned to the subscriber's bank account. + + External refunds log a refund against the Subscriber's entry in Chargify. No funds are returned to the subscriber's bank account. ## External Refund Use Case - + The use case for this type of refund is as follows: + You have a gateway that does not do **direct** refunds back to a Subscribers's bank account @@ -45416,7 +45139,7 @@ x-stoplight: ## Subscriptions Override Documentation - There is no current complimentary documentation for this endpoint. + There is no current complimentary documentation for this endpoint. ## Fields That Can Be Manipulated @@ -45509,9 +45232,9 @@ x-stoplight: ## Response Time Zones - API responses from Chargify are sent with the timezone of current Chargify site. + API responses from Chargify are sent with the timezone of current Chargify site. - Alternately, webhooks sent from Chargify globally utilize EST as the timezone for all content in the body of the payload. + Alternately, webhooks sent from Chargify globally utilize EST as the timezone for all content in the body of the payload. ## Request Data @@ -45570,7 +45293,7 @@ x-stoplight: The Webhooks API allows you to view a list of all webhooks and to selectively resend individual or groups of webhooks. Webhooks will be sent on endpoints specified by you. Endpoints can be added via API or Web UI. - There is also an option to enable / disable webhooks via API request. + There is also an option to enable / disable webhooks via API request. ## Webhooks Documentation @@ -45605,7 +45328,7 @@ x-stoplight: |----------|-------------| | `id` | The unique identifier for resource. Use this id to update an endpoint. | | `url` | Your API url of the webhook integration. | - | `site_id`| ID of your site in Chargify. | + | `site_id`| ID of your site in Chargify. | | `status` | A boolean flag describing wheter endpoint is disabled or enabled. | | `webhooks_subscriptions` | An array of subscribed events keys, each key is a string (e.g. `payment_success`). Visit [Webhook reference](https://help.chargify.com/webhooks/webhooks-reference.html) to learn more. public: true @@ -45617,7 +45340,7 @@ x-stoplight: ReasonCodes are a way to gain a high level view of why your customers are cancelling the subcription to your product or service. - Add a set of churn reason codes to be displayed in-app and/or the Chargify Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. + Add a set of churn reason codes to be displayed in-app and/or the Chargify Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. ## ReasonCode Documentation @@ -45850,7 +45573,7 @@ x-stoplight: + If your site **is** using relationship invoicing, you may only use the methods described in this section for working with invoices. - + If your site is **not** using relationship invoicing, please use the classic invoice methods under the titles of any of the following: + + If your site is **not** using relationship invoicing, please use the classic invoice methods under the titles of any of the following: + [Invoices](#docTextSection:JYyHXetBrWb9vjMJF) + [Invoices: Payments](#docTextSection:AN95FahMs2LLgkico) @@ -45865,12 +45588,12 @@ x-stoplight: Chargify offers the ability to reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://help.chargify.com/subscriptions/reactivation.html). - **Please note: The term + **Please note: The term "resume" is used also during another process in Chargify. This occurs when an on-hold subscription is "resumed". This returns the subscription to an active state.** - + The response returns the subscription object in the `active` or `trialing` state. + + The response returns the subscription object in the `active` or `trialing` state. + The `canceled_at` and `cancellation_message` fields do not have values. - + The method works for "Canceled" or "Trial Ended" subscriptions. + + The method works for "Canceled" or "Trial Ended" subscriptions. + It will not work for items not marked as "Canceled", "Unpaid", or "Trial Ended". ## Optional Parameters @@ -45891,12 +45614,12 @@ x-stoplight: A resumed subscription's billing date remains the same as before it was canceled. In other words, it does not start a new billing period. Payment may or may not be collected for a resumed subscription, depending on whether or not the subscription had a balance when it was canceled (for example, if it was canceled because of dunning). - Consider a subscription which was created on June 1st, and would renew on July 1st. The subscription is then canceled on June 15. + Consider a subscription which was created on June 1st, and would renew on July 1st. The subscription is then canceled on June 15. If a reactivation with `resume: true` were attempted _before_ what would have been the next billing date of July 1st, then Chargify would resume the subscription. If a reactivation with `resume: true` were attempted _after_ what would have been the next billing date of July 1st, then Chargify would not resume the subscription, and instead it would be reactivated with a new billing period. - + | Canceled | Reactivation | Resumable? | |---|---|---| | Jun 15 | June 28 | Yes | @@ -46026,8 +45749,8 @@ x-stoplight: - whether the authentication was successful (`success`) - the gateway ID for the payment (`gateway_payment_id`) - the subscription ID (`subscription_id`) - - Lastly, you can also specify a `redirect_url` within the `action_link` URL if you’d like to redirect a customer back to your site. + + Lastly, you can also specify a `redirect_url` within the `action_link` URL if you’d like to redirect a customer back to your site. The final URL that you send a customer to to complete 3D Secure may resemble the following, where the first half is the `action_link` and the second half contains a `redirect_url` and `callback_url`: `https://mysite.chargify.com/3d-secure/pi_1FCm4RKDeye4C0XfbqquXRYm?one_time_token_id=128&callback_url=https://localhost:4000&redirect_url=https://yourpage.com` @@ -46041,7 +45764,7 @@ x-stoplight: 4. Include 1 of those attributes inside the `callback_url` and `redirect_url` to be aware which “session” this applies to 5. Redirect the customer to the `action_link` with `callback_url` and `redirect_url` applied 6. After the customer finishes 3DS authentication, we let you know the result by making a request to applied `callback_url`. - 7. After that, we redirect the customer to the `redirect_url`; at this point the result of authentication is known + 7. After that, we redirect the customer to the `redirect_url`; at this point the result of authentication is known 8. Optionally, you can use the applied "msg" param in the `redirect_url` to determine whether it was successful or not public: true mrr-overview: @@ -46093,8 +45816,8 @@ x-stoplight: - whether the authentication was successful (`success`) - the gateway ID for the payment (`gateway_payment_id`) - the subscription ID (`subscription_id`) - - Lastly, you can also specify a `redirect_url` within the `action_link` URL if you’d like to redirect a customer back to your site. + + Lastly, you can also specify a `redirect_url` within the `action_link` URL if you’d like to redirect a customer back to your site. The final URL that you send a customer to to complete 3D Secure may resemble the following, where the first half is the `action_link` and the second half contains a `redirect_url` and `callback_url`: `https://mysite.chargify.com/3d-secure/pi_1FCm4RKDeye4C0XfbqquXRYm?one_time_token_id=128&callback_url=https://localhost:4000&redirect_url=https://yourpage.com` @@ -46108,7 +45831,7 @@ x-stoplight: 4. Include 1 of those attributes inside the `callback_url` and `redirect_url` to be aware which “session” this applies to 5. Redirect the customer to the `action_link` with `callback_url` and `redirect_url` applied 6. After the customer finishes 3DS authentication, we let you know the result by making a request to applied `callback_url`. - 7. After that, we redirect the customer to the `redirect_url`; at this point the result of authentication is known + 7. After that, we redirect the customer to the `redirect_url`; at this point the result of authentication is known 8. Optionally, you can use the applied "msg" param in the `redirect_url` to determine whether it was successful or not. public: true sales-commission-intro: @@ -46129,13 +45852,13 @@ x-stoplight: content: |- ## Secure Applications - Please note that it is NOT possible to make API requests directly from the customer's browser or device. Doing so would expose your API key on the client side, and anyone who has that key has full access to all of your Chargify data. + Please note that it is NOT possible to make API requests directly from the customer's browser or device. Doing so would expose your API key on the client side, and anyone who has that key has full access to all of your Chargify data. Instead you will need to take care to tokenize sensitive information by using [Chargify.js](https://developer.chargify.com/content/chargify-js/chargify-js.html) or a similar JavaScript library provided by your gateway, and then post the token and other information to your own server, from which you can make the API call to Chargify. ### Troubleshooting - If you attempt to make a Chargify API request directly from the customer's browser, you may see an error such as: + If you attempt to make a Chargify API request directly from the customer's browser, you may see an error such as: ```Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource.``` @@ -46160,4 +45883,4 @@ x-stoplight: mock: enabled: false dynamic: false -x-tests: {} +x-tests: {} \ No newline at end of file From d2e5462f03c2cba60ba404d0e4cd199389e32970 Mon Sep 17 00:00:00 2001 From: Sergii Shapoval Date: Wed, 21 Jul 2021 21:04:44 +0300 Subject: [PATCH 2/2] gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a09c56d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.idea