diff --git a/AdvancedBilling.Standard/AdvancedBilling.Standard.csproj b/AdvancedBilling.Standard/AdvancedBilling.Standard.csproj index 4c84a98c..292a2006 100644 --- a/AdvancedBilling.Standard/AdvancedBilling.Standard.csproj +++ b/AdvancedBilling.Standard/AdvancedBilling.Standard.csproj @@ -9,13 +9,13 @@ netstandard2.0 Maxio.AdvancedBillingSdk - 9.0.0.0 + 9.1.0.0 MaxioSdk AdvancedBilling.Standard Copyright © 2019 - 9.0.0.0 - 9.0.0.0 + 9.1.0.0 + 9.1.0.0 Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments. 7.3 diff --git a/AdvancedBilling.Standard/AdvancedBillingClient.cs b/AdvancedBilling.Standard/AdvancedBillingClient.cs index e8ee8e93..c5707044 100644 --- a/AdvancedBilling.Standard/AdvancedBillingClient.cs +++ b/AdvancedBilling.Standard/AdvancedBillingClient.cs @@ -42,7 +42,7 @@ public sealed class AdvancedBillingClient : IConfiguration }; private readonly GlobalConfiguration globalConfiguration; - private const string userAgent = "AB SDK DotNet:9.0.0 on OS {os-info}"; + private const string userAgent = "AB SDK DotNet:9.1.0 on OS {os-info}"; private readonly HttpCallback httpCallback; private readonly Lazy aPIExports; private readonly Lazy advanceInvoice; diff --git a/AdvancedBilling.Standard/Controllers/APIExportsController.cs b/AdvancedBilling.Standard/Controllers/APIExportsController.cs index cb1da654..95615380 100644 --- a/AdvancedBilling.Standard/Controllers/APIExportsController.cs +++ b/AdvancedBilling.Standard/Controllers/APIExportsController.cs @@ -25,7 +25,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -37,7 +37,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -61,7 +61,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -73,7 +73,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -97,7 +97,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -109,7 +109,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl /// /// /// @@ -132,7 +132,7 @@ internal APIExportsController(GlobalConfiguration globalConfiguration) : base(gl .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API creates a proforma invoices export and returns a batchjob object. + /// Creates a proforma invoices export and returns a batch job object. /// It is only available for Relationship Invoicing architecture. /// /// Returns the Models.BatchJobResponse response from the API call. @@ -140,7 +140,7 @@ public Models.BatchJobResponse ExportProformaInvoices() => CoreHelper.RunTask(ExportProformaInvoicesAsync()); /// - /// This API creates a proforma invoices export and returns a batchjob object. + /// Creates a proforma invoices export and returns a batch job object. /// It is only available for Relationship Invoicing architecture. /// /// cancellationToken. @@ -156,14 +156,14 @@ public Models.BatchJobResponse ExportProformaInvoices() .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API creates an invoices export and returns a batchjob object. + /// Creates an invoices export and returns a batch job object. /// /// Returns the Models.BatchJobResponse response from the API call. public Models.BatchJobResponse ExportInvoices() => CoreHelper.RunTask(ExportInvoicesAsync()); /// - /// This API creates an invoices export and returns a batchjob object. + /// Creates an invoices export and returns a batch job object. /// /// cancellationToken. /// Returns the Models.BatchJobResponse response from the API call. @@ -178,14 +178,14 @@ public Models.BatchJobResponse ExportInvoices() .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API creates a subscriptions export and returns a batchjob object. + /// Creates a subscriptions export and returns a batch job object. /// /// Returns the Models.BatchJobResponse response from the API call. public Models.BatchJobResponse ExportSubscriptions() => CoreHelper.RunTask(ExportSubscriptionsAsync()); /// - /// This API creates a subscriptions export and returns a batchjob object. + /// Creates a subscriptions export and returns a batch job object. /// /// cancellationToken. /// Returns the Models.BatchJobResponse response from the API call. @@ -199,7 +199,7 @@ public Models.BatchJobResponse ExportSubscriptions() .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API returns a batchjob object for proforma invoices export. + /// Returns a batch job object for a proforma invoices export. /// /// Required parameter: Id of a Batch Job.. /// Returns the Models.BatchJobResponse response from the API call. @@ -208,7 +208,7 @@ public Models.BatchJobResponse ReadProformaInvoicesExport( => CoreHelper.RunTask(ReadProformaInvoicesExportAsync(batchId)); /// - /// This API returns a batchjob object for proforma invoices export. + /// Returns a batch job object for a proforma invoices export. /// /// Required parameter: Id of a Batch Job.. /// cancellationToken. @@ -227,7 +227,7 @@ public Models.BatchJobResponse ReadProformaInvoicesExport( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API returns a batchjob object for invoices export. + /// Returns a batch job object for an invoices export. /// /// Required parameter: Id of a Batch Job.. /// Returns the Models.BatchJobResponse response from the API call. @@ -236,7 +236,7 @@ public Models.BatchJobResponse ReadInvoicesExport( => CoreHelper.RunTask(ReadInvoicesExportAsync(batchId)); /// - /// This API returns a batchjob object for invoices export. + /// Returns a batch job object for an invoices export. /// /// Required parameter: Id of a Batch Job.. /// cancellationToken. @@ -255,7 +255,7 @@ public Models.BatchJobResponse ReadInvoicesExport( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API returns a batchjob object for subscriptions export. + /// Returns a batch job object for a subscriptions export. /// /// Required parameter: Id of a Batch Job.. /// Returns the Models.BatchJobResponse response from the API call. @@ -264,7 +264,7 @@ public Models.BatchJobResponse ReadSubscriptionsExport( => CoreHelper.RunTask(ReadSubscriptionsExportAsync(batchId)); /// - /// This API returns a batchjob object for subscriptions export. + /// Returns a batch job object for a subscriptions export. /// /// Required parameter: Id of a Batch Job.. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/AdvanceInvoiceController.cs b/AdvancedBilling.Standard/Controllers/AdvanceInvoiceController.cs index 231b3e5b..dd365422 100644 --- a/AdvancedBilling.Standard/Controllers/AdvanceInvoiceController.cs +++ b/AdvancedBilling.Standard/Controllers/AdvanceInvoiceController.cs @@ -23,7 +23,7 @@ public class AdvanceInvoiceController : BaseController internal AdvanceInvoiceController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. + /// Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility for generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. /// A subscription may only have one advance invoice per billing period. Attempting to issue an advance invoice when one already exists will return an error. /// That said, regeneration of the invoice may be forced with the params `force: true`, which will void an advance invoice if one exists and generate a new one. If no advance invoice exists, a new one will be generated. /// We recommend using either the create or preview endpoints for proforma invoices to preview this advance invoice before using this endpoint to generate it. @@ -37,7 +37,7 @@ public Models.Invoice IssueAdvanceInvoice( => CoreHelper.RunTask(IssueAdvanceInvoiceAsync(subscriptionId, body)); /// - /// Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. + /// Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility for generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. /// A subscription may only have one advance invoice per billing period. Attempting to issue an advance invoice when one already exists will return an error. /// That said, regeneration of the invoice may be forced with the params `force: true`, which will void an advance invoice if one exists and generate a new one. If no advance invoice exists, a new one will be generated. /// We recommend using either the create or preview endpoints for proforma invoices to preview this advance invoice before using this endpoint to generate it. @@ -64,7 +64,7 @@ public Models.Invoice IssueAdvanceInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Once an advance invoice has been generated for a subscription's upcoming renewal, it can be viewed through this endpoint. There can only be one advance invoice per subscription per billing cycle. + /// Returns the advance invoice generated for a subscription's upcoming renewal. There can only be one advance invoice per subscription per billing cycle. /// /// Required parameter: The Chargify id of the subscription.. /// Returns the Models.Invoice response from the API call. @@ -73,7 +73,7 @@ public Models.Invoice ReadAdvanceInvoice( => CoreHelper.RunTask(ReadAdvanceInvoiceAsync(subscriptionId)); /// - /// Once an advance invoice has been generated for a subscription's upcoming renewal, it can be viewed through this endpoint. There can only be one advance invoice per subscription per billing cycle. + /// Returns the advance invoice generated for a subscription's upcoming renewal. There can only be one advance invoice per subscription per billing cycle. /// /// Required parameter: The Chargify id of the subscription.. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/BillingPortalController.cs b/AdvancedBilling.Standard/Controllers/BillingPortalController.cs index 48c4e740..e9f29cf3 100644 --- a/AdvancedBilling.Standard/Controllers/BillingPortalController.cs +++ b/AdvancedBilling.Standard/Controllers/BillingPortalController.cs @@ -24,9 +24,10 @@ internal BillingPortalController(GlobalConfiguration globalConfiguration) : base /// /// /// - /// This method will provide to the API user the exact URL required for a subscriber to access the Billing Portal. + /// Returns the exact URL required for a subscriber to access the Billing Portal. /// ## Rules for Management Link API. /// + When retrieving a management URL, multiple requests for the same customer in a short period will return the **same** URL. /// + We will not generate a new URL for 15 days. @@ -89,7 +91,7 @@ public Models.PortalManagementLink ReadBillingPortalLink( => CoreHelper.RunTask(ReadBillingPortalLinkAsync(customerId)); /// - /// This method will provide to the API user the exact URL required for a subscriber to access the Billing Portal. + /// Returns the exact URL required for a subscriber to access the Billing Portal. /// ## Rules for Management Link API. /// + When retrieving a management URL, multiple requests for the same customer in a short period will return the **same** URL. /// + We will not generate a new URL for 15 days. @@ -115,11 +117,10 @@ public Models.PortalManagementLink ReadBillingPortalLink( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can resend a customer's Billing Portal invitation. - /// If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with `error` message in the body. + /// Resends a customer's Billing Portal invitation. + /// If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with an `error` message in the body. /// If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. - /// If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. - /// If you attempt to resend an invitation when the Customer does not exist a Customer, you will receive a `404` error response. + /// If you attempt to resend an invitation when the Customer does not exist, you will receive a `404` error response. /// ## Limitations. /// This endpoint will only return a JSON response. /// @@ -130,11 +131,10 @@ public Models.ResentInvitation ResendBillingPortalInvitation( => CoreHelper.RunTask(ResendBillingPortalInvitationAsync(customerId)); /// - /// You can resend a customer's Billing Portal invitation. - /// If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with `error` message in the body. - /// If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. + /// Resends a customer's Billing Portal invitation. + /// If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with an `error` message in the body. /// If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. - /// If you attempt to resend an invitation when the Customer does not exist a Customer, you will receive a `404` error response. + /// If you attempt to resend an invitation when the Customer does not exist, you will receive a `404` error response. /// ## Limitations. /// This endpoint will only return a JSON response. /// @@ -156,7 +156,7 @@ public Models.ResentInvitation ResendBillingPortalInvitation( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can revoke a customer's Billing Portal invitation. + /// Revokes a customer's Billing Portal invitation. /// If you attempt to revoke an invitation when the Billing Portal is already disabled for a Customer, you will receive a 422 error response. /// ## Limitations. /// This endpoint will only return a JSON response. @@ -168,7 +168,7 @@ public Models.RevokedInvitation RevokeBillingPortalAccess( => CoreHelper.RunTask(RevokeBillingPortalAccessAsync(customerId)); /// - /// You can revoke a customer's Billing Portal invitation. + /// Revokes a customer's Billing Portal invitation. /// If you attempt to revoke an invitation when the Billing Portal is already disabled for a Customer, you will receive a 422 error response. /// ## Limitations. /// This endpoint will only return a JSON response. diff --git a/AdvancedBilling.Standard/Controllers/ComponentPricePointsController.cs b/AdvancedBilling.Standard/Controllers/ComponentPricePointsController.cs index e87d56ba..e09155af 100644 --- a/AdvancedBilling.Standard/Controllers/ComponentPricePointsController.cs +++ b/AdvancedBilling.Standard/Controllers/ComponentPricePointsController.cs @@ -94,7 +94,7 @@ public Models.ComponentPricePointResponse CreateComponentPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to read current price points that are associated with a component. + /// Lists the price points associated with a component. /// You may specify the component by using either the numeric id or the `handle:gold` syntax. /// When fetching a component'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 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. @@ -106,7 +106,7 @@ public Models.ComponentPricePointsResponse ListComponentPricePoints( => CoreHelper.RunTask(ListComponentPricePointsAsync(input)); /// - /// Use this endpoint to read current price points that are associated with a component. + /// Lists the price points associated with a component. /// You may specify the component by using either the numeric id or the `handle:gold` syntax. /// When fetching a component'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 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. @@ -130,7 +130,7 @@ public Models.ComponentPricePointsResponse ListComponentPricePoints( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to create multiple component price points in one request. + /// Creates multiple component price points in one request. /// /// Required parameter: The Advanced Billing id of the component for which you want to fetch price points.. /// Optional parameter: . @@ -141,7 +141,7 @@ public Models.ComponentPricePointsResponse BulkCreateComponentPricePoints( => CoreHelper.RunTask(BulkCreateComponentPricePointsAsync(componentId, body)); /// - /// Use this endpoint to create multiple component price points in one request. + /// Creates multiple component price points in one request. /// /// Required parameter: The Advanced Billing id of the component for which you want to fetch price points.. /// Optional parameter: . @@ -218,7 +218,7 @@ public Models.ComponentPricePointCurrencyOverageResponse CloneComponentPricePoin .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// When updating a price point, prices can be updated as well by creating new prices or editing / removing existing ones. + /// Updates a component price point and its associated prices. /// 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. /// Note: Custom price points cannot be updated directly. They must be edited through the Subscription. @@ -234,7 +234,7 @@ public Models.ComponentPricePointResponse UpdateComponentPricePoint( => CoreHelper.RunTask(UpdateComponentPricePointAsync(componentId, pricePointId, body)); /// - /// When updating a price point, prices can be updated as well by creating new prices or editing / removing existing ones. + /// Updates a component price point and its associated prices. /// 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. /// Note: Custom price points cannot be updated directly. They must be edited through the Subscription. @@ -263,7 +263,7 @@ public Models.ComponentPricePointResponse UpdateComponentPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to retrieve details for a specific component price point. You can achieve this by using either the component price point ID or handle. + /// Returns details for a specific component price point. You can achieve this by using either the component price point ID or handle. /// /// Required parameter: The id or handle of the component. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-price_point-handle` for a string handle.. @@ -276,7 +276,7 @@ public Models.ComponentPricePointCurrencyOverageResponse ReadComponentPricePoint => CoreHelper.RunTask(ReadComponentPricePointAsync(componentId, pricePointId, currencyPrices)); /// - /// Use this endpoint to retrieve details for a specific component price point. You can achieve this by using either the component price point ID or handle. + /// Returns details for a specific component price point. You can achieve this by using either the component price point ID or handle. /// /// Required parameter: The id or handle of the component. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-price_point-handle` for a string handle.. @@ -299,7 +299,7 @@ public Models.ComponentPricePointCurrencyOverageResponse ReadComponentPricePoint .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// A price point can be archived at any time. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. + /// Archives a component price point. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. /// /// Required parameter: The id or handle of the component. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-price_point-handle` for a string handle.. @@ -310,7 +310,7 @@ public Models.ComponentPricePointResponse ArchiveComponentPricePoint( => CoreHelper.RunTask(ArchiveComponentPricePointAsync(componentId, pricePointId)); /// - /// A price point can be archived at any time. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. + /// Archives a component price point. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. /// /// Required parameter: The id or handle of the component. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-price_point-handle` for a string handle.. @@ -332,7 +332,7 @@ public Models.ComponentPricePointResponse ArchiveComponentPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to unarchive a component price point. + /// Unarchives a component price point. /// /// Required parameter: The Advanced Billing id of the component to which the price point belongs. /// Required parameter: The Advanced Billing id of the price point. @@ -343,7 +343,7 @@ public Models.ComponentPricePointResponse UnarchiveComponentPricePoint( => CoreHelper.RunTask(UnarchiveComponentPricePointAsync(componentId, pricePointId)); /// - /// Use this endpoint to unarchive a component price point. + /// Unarchives a component price point. /// /// Required parameter: The Advanced Billing id of the component to which the price point belongs. /// Required parameter: The Advanced Billing id of the price point. @@ -363,7 +363,7 @@ public Models.ComponentPricePointResponse UnarchiveComponentPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to create currency prices for a given currency that has been defined on the site level in your settings. + /// Creates currency prices for a given currency defined at the site level. /// When creating currency prices, they need to mirror the structure of your primary pricing. For each price level defined on the component price point, there should be a matching price level created in the given currency. /// Note: Currency Prices are not able to be created for custom price points. /// @@ -376,7 +376,7 @@ public Models.ComponentCurrencyPricesResponse CreateCurrencyPrices( => CoreHelper.RunTask(CreateCurrencyPricesAsync(pricePointId, body)); /// - /// This endpoint allows you to create currency prices for a given currency that has been defined on the site level in your settings. + /// Creates currency prices for a given currency defined at the site level. /// When creating currency prices, they need to mirror the structure of your primary pricing. For each price level defined on the component price point, there should be a matching price level created in the given currency. /// Note: Currency Prices are not able to be created for custom price points. /// @@ -401,7 +401,7 @@ public Models.ComponentCurrencyPricesResponse CreateCurrencyPrices( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to update currency prices for a given currency that has been defined on the site level in your settings. + /// Updates currency prices for a given currency defined at the site level. /// Note: Currency Prices are not able to be updated for custom price points. /// /// Required parameter: The Advanced Billing id of the price point. @@ -413,7 +413,7 @@ public Models.ComponentCurrencyPricesResponse UpdateCurrencyPrices( => CoreHelper.RunTask(UpdateCurrencyPricesAsync(pricePointId, body)); /// - /// This endpoint allows you to update currency prices for a given currency that has been defined on the site level in your settings. + /// Updates currency prices for a given currency defined at the site level. /// Note: Currency Prices are not able to be updated for custom price points. /// /// Required parameter: The Advanced Billing id of the price point. @@ -437,7 +437,7 @@ public Models.ComponentCurrencyPricesResponse UpdateCurrencyPrices( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows to retrieve a list of Components Price Points belonging to a Site. + /// Lists all component price points belonging to a site. /// /// Object containing request parameters. /// Returns the Models.ListComponentsPricePointsResponse response from the API call. @@ -446,7 +446,7 @@ public Models.ListComponentsPricePointsResponse ListAllComponentPricePoints( => CoreHelper.RunTask(ListAllComponentPricePointsAsync(input)); /// - /// This method allows to retrieve a list of Components Price Points belonging to a Site. + /// Lists all component price points belonging to a site. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/ComponentsController.cs b/AdvancedBilling.Standard/Controllers/ComponentsController.cs index 90b39886..afaf8820 100644 --- a/AdvancedBilling.Standard/Controllers/ComponentsController.cs +++ b/AdvancedBilling.Standard/Controllers/ComponentsController.cs @@ -24,8 +24,8 @@ public class ComponentsController : BaseController internal ComponentsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// This request will create a component definition of kind **metered_component** under the specified product family. Metered component can then be added and “allocated” for a subscription. - /// Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Adwords clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. + /// Creates a metered component definition under the specified product family. A metered component can then be added and “allocated” for a subscription. + /// Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Ads clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. /// Note that this is different from recurring quantity-based components, which DO NOT reset to zero at the start of every billing period. If you want to bill for a quantity of something that does not change unless you change it, then you want quantity components, instead. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -38,8 +38,8 @@ public Models.ComponentResponse CreateMeteredComponent( => CoreHelper.RunTask(CreateMeteredComponentAsync(productFamilyId, body)); /// - /// This request will create a component definition of kind **metered_component** under the specified product family. Metered component can then be added and “allocated” for a subscription. - /// Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Adwords clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. + /// Creates a metered component definition under the specified product family. A metered component can then be added and “allocated” for a subscription. + /// Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Ads clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. /// Note that this is different from recurring quantity-based components, which DO NOT reset to zero at the start of every billing period. If you want to bill for a quantity of something that does not change unless you change it, then you want quantity components, instead. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -65,8 +65,8 @@ public Models.ComponentResponse CreateMeteredComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will create a component definition of kind **quantity_based_component** under the specified product family. Quantity Based component can then be added and “allocated” for a subscription. - /// When defining Quantity Based component, You can choose one of 2 types:. + /// Creates a Quantity Based component definition under the specified product family. A Quantity Based component can then be added and “allocated” for a subscription. + /// When defining a Quantity Based component, you can choose one of 2 types:. /// #### Recurring. /// Recurring quantity-based components are used to bill for the number of some unit (think monthly software user licenses or the number of pairs of socks in a box-a-month club). This is most commonly associated with billing for user licenses, number of users, number of employees, etc. /// #### One-time. @@ -83,8 +83,8 @@ public Models.ComponentResponse CreateQuantityBasedComponent( => CoreHelper.RunTask(CreateQuantityBasedComponentAsync(productFamilyId, body)); /// - /// This request will create a component definition of kind **quantity_based_component** under the specified product family. Quantity Based component can then be added and “allocated” for a subscription. - /// When defining Quantity Based component, You can choose one of 2 types:. + /// Creates a Quantity Based component definition under the specified product family. A Quantity Based component can then be added and “allocated” for a subscription. + /// When defining a Quantity Based component, you can choose one of 2 types:. /// #### Recurring. /// Recurring quantity-based components are used to bill for the number of some unit (think monthly software user licenses or the number of pairs of socks in a box-a-month club). This is most commonly associated with billing for user licenses, number of users, number of employees, etc. /// #### One-time. @@ -114,7 +114,7 @@ public Models.ComponentResponse CreateQuantityBasedComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will create a component definition of kind **on_off_component** under the specified product family. On/Off component can then be added and “allocated” for a subscription. + /// Creates an On/Off component definition under the specified product family. An On/Off component can then be added and “allocated” for a subscription. /// On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a flat add on shipping fee). /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -127,7 +127,7 @@ public Models.ComponentResponse CreateOnOffComponent( => CoreHelper.RunTask(CreateOnOffComponentAsync(productFamilyId, body)); /// - /// This request will create a component definition of kind **on_off_component** under the specified product family. On/Off component can then be added and “allocated” for a subscription. + /// Creates an On/Off component definition under the specified product family. An On/Off component can then be added and “allocated” for a subscription. /// On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a flat add on shipping fee). /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -153,7 +153,7 @@ public Models.ComponentResponse CreateOnOffComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will create a component definition of kind **prepaid_usage_component** under the specified product family. Prepaid component can then be added and “allocated” for a subscription. + /// Creates a prepaid usage component definition under the specified product family. A prepaid component can then be added and “allocated” for a subscription. /// Prepaid components allow customers to pre-purchase units that can be used up over time on their subscription. In a sense, they are the mirror image of metered components; while metered components charge at the end of the period for the amount of units used, prepaid components are charged for at the time of purchase, and we subsequently keep track of the usage against the amount purchased. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -166,7 +166,7 @@ public Models.ComponentResponse CreatePrepaidUsageComponent( => CoreHelper.RunTask(CreatePrepaidUsageComponentAsync(productFamilyId, body)); /// - /// This request will create a component definition of kind **prepaid_usage_component** under the specified product family. Prepaid component can then be added and “allocated” for a subscription. + /// Creates a prepaid usage component definition under the specified product family. A prepaid component can then be added and “allocated” for a subscription. /// Prepaid components allow customers to pre-purchase units that can be used up over time on their subscription. In a sense, they are the mirror image of metered components; while metered components charge at the end of the period for the amount of units used, prepaid components are charged for at the time of purchase, and we subsequently keep track of the usage against the amount purchased. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). /// @@ -192,7 +192,7 @@ public Models.ComponentResponse CreatePrepaidUsageComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will create a component definition of kind **event_based_component** under the specified product family. Event-based component can then be added and “allocated” for a subscription. + /// Creates an event-based component definition under the specified product family. An event-based component can then be added and “allocated” for a subscription. /// Event-based components are similar to other component types, in that you define the component parameters (such as name and taxability) and the pricing. A key difference for the event-based component is that it must be attached to a metric. This is because the metric provides the component with the actual quantity used in computing what and how much will be billed each period for each subscription. /// So, instead of reporting usage directly for each component (as you would with metered components), the usage is derived from analysis of your events. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). @@ -206,7 +206,7 @@ public Models.ComponentResponse CreateEventBasedComponent( => CoreHelper.RunTask(CreateEventBasedComponentAsync(productFamilyId, body)); /// - /// This request will create a component definition of kind **event_based_component** under the specified product family. Event-based component can then be added and “allocated” for a subscription. + /// Creates an event-based component definition under the specified product family. An event-based component can then be added and “allocated” for a subscription. /// Event-based components are similar to other component types, in that you define the component parameters (such as name and taxability) and the pricing. A key difference for the event-based component is that it must be attached to a metric. This is because the metric provides the component with the actual quantity used in computing what and how much will be billed each period for each subscription. /// So, instead of reporting usage directly for each component (as you would with metered components), the usage is derived from analysis of your events. /// For more information on components, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Components-Overview). @@ -233,7 +233,7 @@ public Models.ComponentResponse CreateEventBasedComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will return information regarding a component having the handle you provide. You can identify your components with a handle so you don't have to save or reference the IDs we generate. + /// Returns information for a component matching the provided handle. You can identify your components with a handle so you don't have to save or reference the IDs we generate. /// /// Required parameter: The handle of the component to find. /// Returns the Models.ComponentResponse response from the API call. @@ -242,7 +242,7 @@ public Models.ComponentResponse FindComponent( => CoreHelper.RunTask(FindComponentAsync(handle)); /// - /// This request will return information regarding a component having the handle you provide. You can identify your components with a handle so you don't have to save or reference the IDs we generate. + /// Returns information for a component matching the provided handle. You can identify your components with a handle so you don't have to save or reference the IDs we generate. /// /// Required parameter: The handle of the component to find. /// cancellationToken. @@ -292,7 +292,7 @@ public Models.ComponentResponse ReadComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will update a component from a specific product family. + /// Updates a component from a specific product family. /// You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. /// /// Required parameter: The Advanced Billing id of the product family to which the component belongs. @@ -306,7 +306,7 @@ public Models.ComponentResponse UpdateProductFamilyComponent( => CoreHelper.RunTask(UpdateProductFamilyComponentAsync(productFamilyId, componentId, body)); /// - /// This request will update a component from a specific product family. + /// Updates a component from a specific product family. /// You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. /// /// Required parameter: The Advanced Billing id of the product family to which the component belongs. @@ -333,7 +333,7 @@ public Models.ComponentResponse UpdateProductFamilyComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Sending a DELETE request to this endpoint will archive the component. All current subscribers will be unffected; their subscription/purchase will continue to be charged as usual. + /// Archives the component; all current subscribers will continue to be charged as usual. /// /// Required parameter: The Advanced Billing id of the product family to which the component belongs. /// Required parameter: Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`. @@ -344,7 +344,7 @@ public Models.Component ArchiveComponent( => CoreHelper.RunTask(ArchiveComponentAsync(productFamilyId, componentId)); /// - /// Sending a DELETE request to this endpoint will archive the component. All current subscribers will be unffected; their subscription/purchase will continue to be charged as usual. + /// Archives the component; all current subscribers will continue to be charged as usual. /// /// Required parameter: The Advanced Billing id of the product family to which the component belongs. /// Required parameter: Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`. @@ -366,7 +366,7 @@ public Models.Component ArchiveComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will return a list of components for a site. + /// Lists components for a site. /// /// Object containing request parameters. /// Returns the List of Models.ComponentResponse response from the API call. @@ -375,7 +375,7 @@ public Models.Component ArchiveComponent( => CoreHelper.RunTask(ListComponentsAsync(input)); /// - /// This request will return a list of components for a site. + /// Lists components for a site. /// /// Object containing request parameters. /// cancellationToken. @@ -400,7 +400,7 @@ public Models.Component ArchiveComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will update a component. + /// Updates a component. /// You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. /// /// Required parameter: The id or handle of the component. @@ -412,7 +412,7 @@ public Models.ComponentResponse UpdateComponent( => CoreHelper.RunTask(UpdateComponentAsync(componentId, body)); /// - /// This request will update a component. + /// Updates a component. /// You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. /// /// Required parameter: The id or handle of the component. @@ -436,7 +436,7 @@ public Models.ComponentResponse UpdateComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will return a list of components for a particular product family. + /// Lists components for a particular product family. /// /// Object containing request parameters. /// Returns the List of Models.ComponentResponse response from the API call. @@ -445,7 +445,7 @@ public Models.ComponentResponse UpdateComponent( => CoreHelper.RunTask(ListComponentsForProductFamilyAsync(input)); /// - /// This request will return a list of components for a particular product family. + /// Lists components for a particular product family. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/CouponsController.cs b/AdvancedBilling.Standard/Controllers/CouponsController.cs index 3527ff59..4358ca75 100644 --- a/AdvancedBilling.Standard/Controllers/CouponsController.cs +++ b/AdvancedBilling.Standard/Controllers/CouponsController.cs @@ -26,14 +26,12 @@ internal CouponsController(GlobalConfiguration globalConfiguration) : base(globa /// /// ": boolean_value }`. + /// `{ "": boolean_value }` . + /// Coupons can be administered in the Advanced Billing application or created via API. See [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating-Editing-Deleting-Coupons) for more information. + /// See [Apply Coupons to Subscriptions](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions) for information on applying a coupon to a subscription in the Advanced Billing UI. /// ]]> /// /// Required parameter: The Advanced Billing id of the product family to which the coupon belongs. @@ -46,14 +44,12 @@ public Models.CouponResponse CreateCoupon( /// /// ": boolean_value }`. + /// `{ "": boolean_value }` . + /// Coupons can be administered in the Advanced Billing application or created via API. See [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating-Editing-Deleting-Coupons) for more information. + /// See [Apply Coupons to Subscriptions](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions) for information on applying a coupon to a subscription in the Advanced Billing UI. /// ]]> /// /// Required parameter: The Advanced Billing id of the product family to which the coupon belongs. @@ -77,7 +73,7 @@ public Models.CouponResponse CreateCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// List coupons for a specific Product Family in a Site. + /// Lists coupons for a specific product family in a site. /// /// Object containing request parameters. /// Returns the List of Models.CouponResponse response from the API call. @@ -86,7 +82,7 @@ public Models.CouponResponse CreateCoupon( => CoreHelper.RunTask(ListCouponsForProductFamilyAsync(input)); /// - /// List coupons for a specific Product Family in a Site. + /// Lists coupons for a specific product family in a site. /// /// Object containing request parameters. /// cancellationToken. @@ -107,7 +103,7 @@ public Models.CouponResponse CreateCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can search for a coupon via the API with the find method. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If no coupon is found, a 404 is returned. + /// Searches for a coupon by code, returning a 404 if no coupon is found. By passing a code parameter, the find will attempt to locate a coupon that matches that code. /// If you have more than one product family and if the coupon you are trying to find does not belong to the default product family in your site, then you will need to specify (either in the url or as a query string param) the product family id. /// /// Optional parameter: The Advanced Billing id of the product family to which the coupon belongs. @@ -121,7 +117,7 @@ public Models.CouponResponse FindCoupon( => CoreHelper.RunTask(FindCouponAsync(productFamilyId, code, currencyPrices)); /// - /// You can search for a coupon via the API with the find method. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If no coupon is found, a 404 is returned. + /// Searches for a coupon by code, returning a 404 if no coupon is found. By passing a code parameter, the find will attempt to locate a coupon that matches that code. /// If you have more than one product family and if the coupon you are trying to find does not belong to the default product family in your site, then you will need to specify (either in the url or as a query string param) the product family id. /// /// Optional parameter: The Advanced Billing id of the product family to which the coupon belongs. @@ -145,7 +141,7 @@ public Models.CouponResponse FindCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. + /// Returns a coupon by its Advanced Billing-assigned ID. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. /// If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. /// When fetching a coupon, 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 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. @@ -161,7 +157,7 @@ public Models.CouponResponse ReadCoupon( => CoreHelper.RunTask(ReadCouponAsync(productFamilyId, couponId, currencyPrices)); /// - /// You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. + /// Returns a coupon by its Advanced Billing-assigned ID. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. /// If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. /// When fetching a coupon, 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 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. @@ -188,8 +184,7 @@ public Models.CouponResponse ReadCoupon( /// /// ": boolean_value }`. /// ]]> @@ -206,8 +201,7 @@ public Models.CouponResponse UpdateCoupon( /// /// ": boolean_value }`. /// ]]> @@ -236,7 +230,7 @@ public Models.CouponResponse UpdateCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can archive a Coupon via the API with the archive method. + /// Archives a coupon, making it unavailable for future use while remaining active on existing subscriptions. /// Archiving makes that Coupon unavailable for future use, but allows it to remain attached and functional on existing Subscriptions that are using it. /// The `archived_at` date and time will be assigned. /// @@ -249,7 +243,7 @@ public Models.CouponResponse ArchiveCoupon( => CoreHelper.RunTask(ArchiveCouponAsync(productFamilyId, couponId)); /// - /// You can archive a Coupon via the API with the archive method. + /// Archives a coupon, making it unavailable for future use while remaining active on existing subscriptions. /// Archiving makes that Coupon unavailable for future use, but allows it to remain attached and functional on existing Subscriptions that are using it. /// The `archived_at` date and time will be assigned. /// @@ -271,7 +265,7 @@ public Models.CouponResponse ArchiveCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can retrieve a list of coupons. + /// Lists coupons for a site. /// /// Object containing request parameters. /// Returns the List of Models.CouponResponse response from the API call. @@ -280,7 +274,7 @@ public Models.CouponResponse ArchiveCoupon( => CoreHelper.RunTask(ListCouponsAsync(input)); /// - /// You can retrieve a list of coupons. + /// Lists coupons for a site. /// /// Object containing request parameters. /// cancellationToken. @@ -300,7 +294,7 @@ public Models.CouponResponse ArchiveCoupon( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will provide details about the coupon usage as an array of data hashes, one per product. + /// Lists coupon usage details, one entry per product. /// /// Required parameter: The Advanced Billing id of the product family to which the coupon belongs.. /// Required parameter: The Advanced Billing id of the coupon.. @@ -311,7 +305,7 @@ public Models.CouponResponse ArchiveCoupon( => CoreHelper.RunTask(ReadCouponUsageAsync(productFamilyId, couponId)); /// - /// This request will provide details about the coupon usage as an array of data hashes, one per product. + /// Lists coupon usage details, one entry per product. /// /// Required parameter: The Advanced Billing id of the product family to which the coupon belongs.. /// Required parameter: The Advanced Billing id of the coupon.. @@ -332,7 +326,7 @@ public Models.CouponResponse ArchiveCoupon( /// /// /// - /// This endpoint allows you to create and/or update currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. + /// Creates and/or updates currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. /// Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary coupon is percentage based, you will not be able to define pricing in non-primary currencies. /// /// Required parameter: The Advanced Billing id of the coupon. @@ -406,7 +400,7 @@ public Models.CouponCurrencyResponse CreateOrUpdateCouponCurrencyPrices( => CoreHelper.RunTask(CreateOrUpdateCouponCurrencyPricesAsync(couponId, body)); /// - /// This endpoint allows you to create and/or update currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. + /// Creates and/or updates currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. /// Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary coupon is percentage based, you will not be able to define pricing in non-primary currencies. /// /// Required parameter: The Advanced Billing id of the coupon. @@ -431,6 +425,7 @@ public Models.CouponCurrencyResponse CreateOrUpdateCouponCurrencyPrices( /// /// /// - /// This request allows you to request the subcodes that are attached to a coupon. + /// Lists the subcodes attached to a coupon. /// /// Object containing request parameters. /// Returns the Models.CouponSubcodes response from the API call. @@ -521,7 +517,7 @@ public Models.CouponSubcodes ListCouponSubcodes( => CoreHelper.RunTask(ListCouponSubcodesAsync(input)); /// - /// This request allows you to request the subcodes that are attached to a coupon. + /// Lists the subcodes attached to a coupon. /// /// Object containing request parameters. /// cancellationToken. @@ -540,7 +536,7 @@ public Models.CouponSubcodes ListCouponSubcodes( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// You can update the subcodes for the given Coupon via the API with a PUT request to the resource endpoint. + /// Updates the subcodes for a coupon, replacing all existing subcodes with the new list. /// Send an array of new coupon subcodes. /// **Note**: All current subcodes for that Coupon will be deleted first, and replaced with the list of subcodes sent to this endpoint. /// The response will contain:. @@ -557,7 +553,7 @@ public Models.CouponSubcodesResponse UpdateCouponSubcodes( => CoreHelper.RunTask(UpdateCouponSubcodesAsync(couponId, body)); /// - /// You can update the subcodes for the given Coupon via the API with a PUT request to the resource endpoint. + /// Updates the subcodes for a coupon, replacing all existing subcodes with the new list. /// Send an array of new coupon subcodes. /// **Note**: All current subcodes for that Coupon will be deleted first, and replaced with the list of subcodes sent to this endpoint. /// The response will contain:. @@ -585,6 +581,7 @@ public Models.CouponSubcodesResponse UpdateCouponSubcodes( /// /// /// Note: Updates to metadata overwrite. To add one or more values, you must specify all metadata values including the new value you want to add. /// - Add new metadata to a dropdown or radio for a metafield that was created without metadata. - /// - Remove metadata for a dropdown or radio for a metafield. . + /// - Remove metadata for a dropdown or radio for a metafield. /// >Note: Updates to metadata overwrite existing values. To remove one or more values, specify all metadata values except those you want to remove. /// - Add or update scope settings for a metafield. /// >Note: Scope changes overwrite existing settings. You must specify the complete scope, including the changes you want to make. @@ -138,7 +138,7 @@ public Models.ListMetafieldsResponse ListMetafields( /// - Add metadata values to the existing metadata for a dropdown or radio metafield. . /// >Note: Updates to metadata overwrite. To add one or more values, you must specify all metadata values including the new value you want to add. /// - Add new metadata to a dropdown or radio for a metafield that was created without metadata. - /// - Remove metadata for a dropdown or radio for a metafield. . + /// - Remove metadata for a dropdown or radio for a metafield. /// >Note: Updates to metadata overwrite existing values. To remove one or more values, specify all metadata values except those you want to remove. /// - Add or update scope settings for a metafield. /// >Note: Scope changes overwrite existing settings. You must specify the complete scope, including the changes you want to make. @@ -270,7 +270,7 @@ public Models.PaginatedMetadata ListMetadata( /// /// Updates metadata and metafields on the Site and the customer or subscription specified, and updates the metadata value on a subscription or customer. /// If you update metadata on a subscription or customer with a metafield that does not already exist, the metafield is created with the metadata you specify and it is always added as a text field to the Site and to the subscription or customer you specify. You can update the input_type for the metafield with the Update Metafield endpoint. . - /// Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for Subscription and another 100 for Customer. + /// Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for the Subscription resource and another 100 for the Customer resource. /// /// Required parameter: The resource type to which the metafields belong.. /// Required parameter: The Advanced Billing id of the customer or the subscription for which the metadata applies. @@ -285,7 +285,7 @@ public Models.PaginatedMetadata ListMetadata( /// /// Updates metadata and metafields on the Site and the customer or subscription specified, and updates the metadata value on a subscription or customer. /// If you update metadata on a subscription or customer with a metafield that does not already exist, the metafield is created with the metadata you specify and it is always added as a text field to the Site and to the subscription or customer you specify. You can update the input_type for the metafield with the Update Metafield endpoint. . - /// Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for Subscription and another 100 for Customer. + /// Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for the Subscription resource and another 100 for the Customer resource. /// /// Required parameter: The resource type to which the metafields belong.. /// Required parameter: The Advanced Billing id of the customer or the subscription for which the metadata applies. @@ -353,7 +353,7 @@ public async Task DeleteMetadataAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Lists metadata for a specified array of subscriptions or customers. + /// Lists metadata for a specified array of subscriptions or customers. /// /// Object containing request parameters. /// Returns the Models.PaginatedMetadata response from the API call. @@ -362,7 +362,7 @@ public Models.PaginatedMetadata ListMetadataForResourceType( => CoreHelper.RunTask(ListMetadataForResourceTypeAsync(input)); /// - /// Lists metadata for a specified array of subscriptions or customers. + /// Lists metadata for a specified array of subscriptions or customers. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/CustomersController.cs b/AdvancedBilling.Standard/Controllers/CustomersController.cs index da8930bf..5c7e5a74 100644 --- a/AdvancedBilling.Standard/Controllers/CustomersController.cs +++ b/AdvancedBilling.Standard/Controllers/CustomersController.cs @@ -25,7 +25,7 @@ public class CustomersController : BaseController internal CustomersController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// 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. + /// Creates a new customer; can also be created alongside a new 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 Advanced Billing’s unique ID for the customer, which is in the `id` attribute. /// Full documentation on how to locate, create and edit Customers in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252190590093-Customer-Details). /// ## Required Country Format. @@ -46,7 +46,7 @@ public Models.CustomerResponse CreateCustomer( => CoreHelper.RunTask(CreateCustomerAsync(body)); /// - /// 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. + /// Creates a new customer; can also be created alongside a new 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 Advanced Billing’s unique ID for the customer, which is in the `id` attribute. /// Full documentation on how to locate, create and edit Customers in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252190590093-Customer-Details). /// ## Required Country Format. @@ -78,7 +78,7 @@ public Models.CustomerResponse CreateCustomer( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will by default list all customers associated with your Site. + /// Lists all customers associated with your site, or filters results using the search parameter. /// ## Find Customer. /// Use the search feature with the `q` query parameter to retrieve an array of customers that matches the search query. /// Common use cases are:. @@ -96,7 +96,7 @@ public Models.CustomerResponse CreateCustomer( => CoreHelper.RunTask(ListCustomersAsync(input)); /// - /// This request will by default list all customers associated with your Site. + /// Lists all customers associated with your site, or filters results using the search parameter. /// ## Find Customer. /// Use the search feature with the `q` query parameter to retrieve an array of customers that matches the search query. /// Common use cases are:. @@ -156,7 +156,7 @@ public Models.CustomerResponse ReadCustomer( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows to update the Customer. + /// Updates the customer. /// /// Required parameter: The Advanced Billing id of the customer. /// Optional parameter: . @@ -167,7 +167,7 @@ public Models.CustomerResponse UpdateCustomer( => CoreHelper.RunTask(UpdateCustomerAsync(id, body)); /// - /// This method allows to update the Customer. + /// Updates the customer. /// /// Required parameter: The Advanced Billing id of the customer. /// Optional parameter: . @@ -191,7 +191,7 @@ public Models.CustomerResponse UpdateCustomer( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows you to delete the Customer. + /// Deletes the customer. /// /// Required parameter: The Advanced Billing id of the customer. public void DeleteCustomer( @@ -199,7 +199,7 @@ public void DeleteCustomer( => CoreHelper.RunVoidTask(DeleteCustomerAsync(id)); /// - /// This method allows you to delete the Customer. + /// Deletes the customer. /// /// Required parameter: The Advanced Billing id of the customer. /// cancellationToken. @@ -216,7 +216,7 @@ public async Task DeleteCustomerAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this method to return the customer object if you have the unique **Reference ID (Your App)** value handy. It will return a single match. + /// Returns a customer by their unique reference ID. It will return a single match. /// /// Required parameter: Customer reference. /// Returns the Models.CustomerResponse response from the API call. @@ -225,7 +225,7 @@ public Models.CustomerResponse ReadCustomerByReference( => CoreHelper.RunTask(ReadCustomerByReferenceAsync(reference)); /// - /// Use this method to return the customer object if you have the unique **Reference ID (Your App)** value handy. It will return a single match. + /// Returns a customer by their unique reference ID. It will return a single match. /// /// Required parameter: Customer reference. /// cancellationToken. @@ -242,7 +242,7 @@ public Models.CustomerResponse ReadCustomerByReference( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method lists all subscriptions that belong to a customer. + /// Lists all subscriptions that belong to a customer. /// /// Required parameter: The Chargify id of the customer. /// Returns the List of Models.SubscriptionResponse response from the API call. @@ -251,7 +251,7 @@ public Models.CustomerResponse ReadCustomerByReference( => CoreHelper.RunTask(ListCustomerSubscriptionsAsync(customerId)); /// - /// This method lists all subscriptions that belong to a customer. + /// Lists all subscriptions that belong to a customer. /// /// Required parameter: The Chargify id of the customer. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/EventsBasedBillingSegmentsController.cs b/AdvancedBilling.Standard/Controllers/EventsBasedBillingSegmentsController.cs index f7f21d08..28d82365 100644 --- a/AdvancedBilling.Standard/Controllers/EventsBasedBillingSegmentsController.cs +++ b/AdvancedBilling.Standard/Controllers/EventsBasedBillingSegmentsController.cs @@ -24,7 +24,7 @@ public class EventsBasedBillingSegmentsController : BaseController internal EventsBasedBillingSegmentsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// This endpoint creates a new Segment for a Component with segmented Metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. + /// Creates a new segment for a component with a segmented metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle for the Component. @@ -38,7 +38,7 @@ public Models.SegmentResponse CreateSegment( => CoreHelper.RunTask(CreateSegmentAsync(componentId, pricePointId, body)); /// - /// This endpoint creates a new Segment for a Component with segmented Metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. + /// Creates a new segment for a component with a segmented metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle for the Component. @@ -66,7 +66,7 @@ public Models.SegmentResponse CreateSegment( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to fetch Segments created for a given Price Point. They will be returned in the order of creation. + /// Lists segments created for a given price point, in order of creation. /// You can pass `page` and `per_page` parameters in order to access all of the segments. By default it will return `30` records. You can set `per_page` to `200` at most. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// @@ -77,7 +77,7 @@ public Models.ListSegmentsResponse ListSegmentsForPricePoint( => CoreHelper.RunTask(ListSegmentsForPricePointAsync(input)); /// - /// This endpoint allows you to fetch Segments created for a given Price Point. They will be returned in the order of creation. + /// Lists segments created for a given price point, in order of creation. /// You can pass `page` and `per_page` parameters in order to access all of the segments. By default it will return `30` records. You can set `per_page` to `200` at most. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// @@ -103,7 +103,7 @@ public Models.ListSegmentsResponse ListSegmentsForPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint updates a single Segment for a Component with a segmented Metric. It allows you to update the pricing for the segment. + /// Updates a single segment for a component with a segmented metric. It allows you to update the pricing for the segment. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle of the Component. @@ -119,7 +119,7 @@ public Models.SegmentResponse UpdateSegment( => CoreHelper.RunTask(UpdateSegmentAsync(componentId, pricePointId, id, body)); /// - /// This endpoint updates a single Segment for a Component with a segmented Metric. It allows you to update the pricing for the segment. + /// Updates a single segment for a component with a segmented metric. It allows you to update the pricing for the segment. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle of the Component. @@ -150,7 +150,7 @@ public Models.SegmentResponse UpdateSegment( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to delete a Segment with specified ID. + /// Deletes a segment with the specified ID. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle of the Component. @@ -163,7 +163,7 @@ public void DeleteSegment( => CoreHelper.RunVoidTask(DeleteSegmentAsync(componentId, pricePointId, id)); /// - /// This endpoint allows you to delete a Segment with specified ID. + /// Deletes a segment with the specified ID. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// /// Required parameter: ID or Handle of the Component. @@ -190,7 +190,7 @@ public async Task DeleteSegmentAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to create multiple segments in one request. The array of segments can contain up to `2000` records. + /// Creates multiple segments in one request. The array of segments can contain up to `2000` records. /// If any of the records contain an error the whole request would fail and none of the requested segments get created. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// @@ -205,7 +205,7 @@ public Models.ListSegmentsResponse BulkCreateSegments( => CoreHelper.RunTask(BulkCreateSegmentsAsync(componentId, pricePointId, body)); /// - /// This endpoint allows you to create multiple segments in one request. The array of segments can contain up to `2000` records. + /// Creates multiple segments in one request. The array of segments can contain up to `2000` records. /// If any of the records contain an error the whole request would fail and none of the requested segments get created. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// @@ -234,7 +234,7 @@ public Models.ListSegmentsResponse BulkCreateSegments( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint allows you to update multiple segments in one request. The array of segments can contain up to `1000` records. + /// Updates multiple segments in one request. The array of segments can contain up to `1000` records. /// If any of the records contain an error the whole request would fail and none of the requested segments get updated. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// @@ -249,7 +249,7 @@ public Models.ListSegmentsResponse BulkUpdateSegments( => CoreHelper.RunTask(BulkUpdateSegmentsAsync(componentId, pricePointId, body)); /// - /// This endpoint allows you to update multiple segments in one request. The array of segments can contain up to `1000` records. + /// Updates multiple segments in one request. The array of segments can contain up to `1000` records. /// If any of the records contain an error the whole request would fail and none of the requested segments get updated. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. /// You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. /// diff --git a/AdvancedBilling.Standard/Controllers/EventsController.cs b/AdvancedBilling.Standard/Controllers/EventsController.cs index a3defa00..ea0a3ef3 100644 --- a/AdvancedBilling.Standard/Controllers/EventsController.cs +++ b/AdvancedBilling.Standard/Controllers/EventsController.cs @@ -24,9 +24,10 @@ public class EventsController : BaseController internal EventsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// + /// Lists events for a site. /// ## Events Intro. /// Advanced Billing Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. - /// Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to record view Events / Site Activty in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). + /// Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to view Events / Site Activity in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). /// ## List Events for a Site. /// This method will retrieve a list of events for a site. Use query string filters to narrow down results. You may use the `key` filter as part of your query string to narrow down results. /// ### Legacy Filters. @@ -84,9 +85,10 @@ internal EventsController(GlobalConfiguration globalConfiguration) : base(global => CoreHelper.RunTask(ListEventsAsync(input)); /// + /// Lists events for a site. /// ## Events Intro. /// Advanced Billing Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. - /// Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to record view Events / Site Activty in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). + /// Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to view Events / Site Activity in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). /// ## List Events for a Site. /// This method will retrieve a list of events for a site. Use query string filters to narrow down results. You may use the `key` filter as part of your query string to narrow down results. /// ### Legacy Filters. @@ -162,7 +164,7 @@ internal EventsController(GlobalConfiguration globalConfiguration) : base(global .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// The following request will return a list of events for a subscription. + /// Lists events for a subscription. /// ## Event Key. /// The event type is identified by the key property. You can check supported keys [here]($m/Event%20Key). /// ## Event Specific Data. @@ -177,7 +179,7 @@ internal EventsController(GlobalConfiguration globalConfiguration) : base(global => CoreHelper.RunTask(ListSubscriptionEventsAsync(input)); /// - /// The following request will return a list of events for a subscription. + /// Lists events for a subscription. /// ## Event Key. /// The event type is identified by the key property. You can check supported keys [here]($m/Event%20Key). /// ## Event Specific Data. @@ -206,7 +208,7 @@ internal EventsController(GlobalConfiguration globalConfiguration) : base(global .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Get a count of all the events for a given site by using this method. + /// Returns the total count of events for a given site. /// /// Object containing request parameters. /// Returns the Models.CountResponse response from the API call. @@ -215,7 +217,7 @@ public Models.CountResponse ReadEventsCount( => CoreHelper.RunTask(ReadEventsCountAsync(input)); /// - /// Get a count of all the events for a given site by using this method. + /// Returns the total count of events for a given site. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/InsightsController.cs b/AdvancedBilling.Standard/Controllers/InsightsController.cs index 6fb12085..a96301e4 100644 --- a/AdvancedBilling.Standard/Controllers/InsightsController.cs +++ b/AdvancedBilling.Standard/Controllers/InsightsController.cs @@ -24,7 +24,7 @@ public class InsightsController : BaseController internal InsightsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// The Stats API is a very basic view of some Site-level stats. This API call only answers with JSON responses. An XML version is not provided. + /// Returns basic site-level stats. This API call only answers with JSON responses. An XML version is not provided. /// ## 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 response. /// ```. @@ -36,7 +36,7 @@ public Models.SiteSummary ReadSiteStats() => CoreHelper.RunTask(ReadSiteStatsAsync()); /// - /// The Stats API is a very basic view of some Site-level stats. This API call only answers with JSON responses. An XML version is not provided. + /// Returns basic site-level stats. This API call only answers with JSON responses. An XML version is not provided. /// ## 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 response. /// ```. @@ -53,7 +53,7 @@ public Models.SiteSummary ReadSiteStats() .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint returns your site's current MRR, including plan and usage breakouts. + /// Returns your site's current MRR, including plan and usage breakouts. /// /// Optional parameter: submit a timestamp in ISO8601 format to request MRR for a historic time. /// Optional parameter: submit the id of a subscription in order to limit results. @@ -65,7 +65,7 @@ public Models.MRRResponse ReadMrr( => CoreHelper.RunTask(ReadMrrAsync(atTime, subscriptionId)); /// - /// This endpoint returns your site's current MRR, including plan and usage breakouts. + /// Returns your site's current MRR, including plan and usage breakouts. /// /// Optional parameter: submit a timestamp in ISO8601 format to request MRR for a historic time. /// Optional parameter: submit the id of a subscription in order to limit results. @@ -87,7 +87,7 @@ public Models.MRRResponse ReadMrr( /// /// /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. /// Optional parameter: . @@ -42,7 +42,7 @@ public Models.Invoice RefundInvoice( /// Refund an invoice, segment, or consolidated invoice. /// ## Partial Refund for Consolidated Invoice. /// A refund less than the total of a consolidated invoice will be split across its segments. - /// A $50.00 refund on a $100.00 consolidated invoice with one $60.00 and one $40.00 segment, the refunded amount will be applied as 50% of each ($30.00 and $20.00 respectively). + /// For a $50.00 refund on a $100.00 consolidated invoice with one $60.00 segment and one $40.00 segment, the refunded amount will be applied as 50% of each ($30.00 and $20.00, respectively). /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. /// Optional parameter: . @@ -266,7 +266,7 @@ public Models.Invoice RecordPaymentForInvoice( /// /// This API call should be used when you want to record an external payment against multiple invoices. - /// In order apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. + /// To apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. /// ```. /// {. /// "payment": {. @@ -297,7 +297,7 @@ public Models.MultiInvoicePaymentResponse RecordPaymentForMultipleInvoices( /// /// This API call should be used when you want to record an external payment against multiple invoices. - /// In order apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. + /// To apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. /// ```. /// {. /// "payment": {. @@ -575,14 +575,14 @@ public Models.ConsolidatedInvoice ListConsolidatedInvoiceSegments( /// }. /// ```. /// The price for each line item will be calculated as well as a total due amount for the invoice. Multiple line items can be sent. - /// ### Line items types. - /// When defining line item, You can choose one of 3 types for one line item:. + /// ### Line item types. + /// When defining a line item, You can choose one of 3 types for a line item:. /// #### Custom item. - /// Like in basic behavior example above, You can pass `title` and `unit_price` for custom item. + /// As shown in the basic behavior example, You can pass `title` and `unit_price` for custom item. /// #### Product id. /// Product handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `product_price_point_id`. If `product_id` is used, following fields cannot be used: `title`, `component_id`. /// #### Component id. - /// Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supportted only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. + /// Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supported only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. /// ### Coupons. /// When creating ad hoc invoice, new discounts can be applied in following way:. /// ```json. @@ -677,13 +677,13 @@ public Models.ConsolidatedInvoice ListConsolidatedInvoiceSegments( /// Optional `description` parameter, it will overwrite default generated description for line item. /// ### Invoice Options. /// #### Issue Date. - /// By default, invoices will be created with a issue date set to today. `issue_date` parameter can be send to alter that. Only dates in the past can be send. `issue_date` should be send in `YYYY-MM-DD` format. + /// By default, invoices will be created with a issue date set to today in your site's time zone. The `issue_date` parameter can be sent to alter the default. Only today or dates in the past are accepted. This date is interpreted and validated in your site's time zone. The format for `issue_date` is `YYYY-MM-DD`. /// #### Net Terms. /// By default, invoices will be created with a due date matching the date of invoice creation. If a different due date is desired, the `net_terms` parameter can be sent indicating the number of days in advance the due date should be. /// #### Addresses. /// The seller, shipping and billing addresses can be sent to override the site's defaults. Each address requires to send a `first_name` at a minimum in order to work. See below for the details on which parameters can be sent for each address object. /// #### Memo and Payment Instructions. - /// A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instrucions` parameter. + /// A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instructions` parameter. /// #### Status. /// By default, invoices will be created with open status. Possible alternative is `draft`. /// @@ -727,14 +727,14 @@ public Models.InvoiceResponse CreateInvoice( /// }. /// ```. /// The price for each line item will be calculated as well as a total due amount for the invoice. Multiple line items can be sent. - /// ### Line items types. - /// When defining line item, You can choose one of 3 types for one line item:. + /// ### Line item types. + /// When defining a line item, You can choose one of 3 types for a line item:. /// #### Custom item. - /// Like in basic behavior example above, You can pass `title` and `unit_price` for custom item. + /// As shown in the basic behavior example, You can pass `title` and `unit_price` for custom item. /// #### Product id. /// Product handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `product_price_point_id`. If `product_id` is used, following fields cannot be used: `title`, `component_id`. /// #### Component id. - /// Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supportted only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. + /// Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supported only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. /// ### Coupons. /// When creating ad hoc invoice, new discounts can be applied in following way:. /// ```json. @@ -829,13 +829,13 @@ public Models.InvoiceResponse CreateInvoice( /// Optional `description` parameter, it will overwrite default generated description for line item. /// ### Invoice Options. /// #### Issue Date. - /// By default, invoices will be created with a issue date set to today. `issue_date` parameter can be send to alter that. Only dates in the past can be send. `issue_date` should be send in `YYYY-MM-DD` format. + /// By default, invoices will be created with a issue date set to today in your site's time zone. The `issue_date` parameter can be sent to alter the default. Only today or dates in the past are accepted. This date is interpreted and validated in your site's time zone. The format for `issue_date` is `YYYY-MM-DD`. /// #### Net Terms. /// By default, invoices will be created with a due date matching the date of invoice creation. If a different due date is desired, the `net_terms` parameter can be sent indicating the number of days in advance the due date should be. /// #### Addresses. /// The seller, shipping and billing addresses can be sent to override the site's defaults. Each address requires to send a `first_name` at a minimum in order to work. See below for the details on which parameters can be sent for each address object. /// #### Memo and Payment Instructions. - /// A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instrucions` parameter. + /// A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instructions` parameter. /// #### Status. /// By default, invoices will be created with open status. Possible alternative is `draft`. /// @@ -899,7 +899,7 @@ public async Task SendInvoiceAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Customer information may change after an invoice is issued which may lead to a mismatch between customer information that are present on an open invoice and actual customer information. This endpoint allows to preview these differences, if any. + /// Customer information may change after an invoice is issued, which may lead to a mismatch between customer information that is present on an open invoice and actual customer information. This endpoint allows you to preview these differences, if any. /// The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. @@ -909,7 +909,7 @@ public Models.CustomerChangesPreviewResponse PreviewCustomerInformationChanges( => CoreHelper.RunTask(PreviewCustomerInformationChangesAsync(uid)); /// - /// Customer information may change after an invoice is issued which may lead to a mismatch between customer information that are present on an open invoice and actual customer information. This endpoint allows to preview these differences, if any. + /// Customer information may change after an invoice is issued, which may lead to a mismatch between customer information that is present on an open invoice and actual customer information. This endpoint allows you to preview these differences, if any. /// The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. @@ -930,7 +930,7 @@ public Models.CustomerChangesPreviewResponse PreviewCustomerInformationChanges( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint before. + /// This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint first. /// The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. @@ -940,7 +940,7 @@ public Models.Invoice UpdateCustomerInformation( => CoreHelper.RunTask(UpdateCustomerInformationAsync(uid)); /// - /// This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint before. + /// This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint first. /// The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. /// /// Required parameter: The unique identifier for the invoice, this does not refer to the public facing invoice number.. @@ -963,8 +963,8 @@ public Models.Invoice UpdateCustomerInformation( /// /// This endpoint allows you to issue an invoice that is in "pending" or "draft" status. For example, you can issue an invoice that was created when allocating new quantity on a component and using "accrue charges" option. /// You cannot issue a pending child invoice that was created for a member subscription in a group. - /// For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on subscription will be automatically applied. Additionally, if setting is on, an email will be sent for issued invoice. - /// For Automatic subscriptions, prepayments and service credits will apply to the invoice and before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value:. + /// For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on the subscription will be automatically applied. Additionally, if the setting is enabled, an email will be sent for the issued invoice. + /// For Automatic subscriptions, prepayments and service credits will apply to the invoice before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value:. /// - `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option. /// - `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history. /// - `initiate_dunning` - prepayments and credits applied to the invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history; subscription will most likely go into "past_due" or "canceled" state (depending upon net terms and dunning settings). @@ -980,8 +980,8 @@ public Models.Invoice IssueInvoice( /// /// This endpoint allows you to issue an invoice that is in "pending" or "draft" status. For example, you can issue an invoice that was created when allocating new quantity on a component and using "accrue charges" option. /// You cannot issue a pending child invoice that was created for a member subscription in a group. - /// For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on subscription will be automatically applied. Additionally, if setting is on, an email will be sent for issued invoice. - /// For Automatic subscriptions, prepayments and service credits will apply to the invoice and before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value:. + /// For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on the subscription will be automatically applied. Additionally, if the setting is enabled, an email will be sent for the issued invoice. + /// For Automatic subscriptions, prepayments and service credits will apply to the invoice before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value:. /// - `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option. /// - `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history. /// - `initiate_dunning` - prepayments and credits applied to the invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history; subscription will most likely go into "past_due" or "canceled" state (depending upon net terms and dunning settings). diff --git a/AdvancedBilling.Standard/Controllers/OffersController.cs b/AdvancedBilling.Standard/Controllers/OffersController.cs index dc4d054a..74022b46 100644 --- a/AdvancedBilling.Standard/Controllers/OffersController.cs +++ b/AdvancedBilling.Standard/Controllers/OffersController.cs @@ -24,7 +24,7 @@ public class OffersController : BaseController internal OffersController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Create an offer within your Advanced Billing site by sending a POST request. + /// Creates an offer within your Advanced Billing site. /// ## Documentation. /// Offers allow you to package complicated combinations of products, components and coupons into a convenient package which can then be subscribed to just like products. /// Once an offer is defined it can be used as an alternative to the product when creating subscriptions. @@ -39,7 +39,7 @@ public Models.OfferResponse CreateOffer( => CoreHelper.RunTask(CreateOfferAsync(body)); /// - /// Create an offer within your Advanced Billing site by sending a POST request. + /// Creates an offer within your Advanced Billing site. /// ## Documentation. /// Offers allow you to package complicated combinations of products, components and coupons into a convenient package which can then be subscribed to just like products. /// Once an offer is defined it can be used as an alternative to the product when creating subscriptions. @@ -65,7 +65,7 @@ public Models.OfferResponse CreateOffer( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will list offers for a site. + /// Lists offers for a site. /// /// Object containing request parameters. /// Returns the Models.ListOffersResponse response from the API call. @@ -74,7 +74,7 @@ public Models.ListOffersResponse ListOffers( => CoreHelper.RunTask(ListOffersAsync(input)); /// - /// This endpoint will list offers for a site. + /// Lists offers for a site. /// /// Object containing request parameters. /// cancellationToken. @@ -95,7 +95,7 @@ public Models.ListOffersResponse ListOffers( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows you to list a specific offer's attributes. This is different than list all offers for a site, as it requires an `offer_id`. + /// Returns a specific offer's attributes. This is different from listing all offers for a site, as it requires an `offer_id`. /// /// Required parameter: The Chargify id of the offer. /// Returns the Models.OfferResponse response from the API call. @@ -104,7 +104,7 @@ public Models.OfferResponse ReadOffer( => CoreHelper.RunTask(ReadOfferAsync(offerId)); /// - /// This method allows you to list a specific offer's attributes. This is different than list all offers for a site, as it requires an `offer_id`. + /// Returns a specific offer's attributes. This is different from listing all offers for a site, as it requires an `offer_id`. /// /// Required parameter: The Chargify id of the offer. /// cancellationToken. @@ -121,7 +121,7 @@ public Models.OfferResponse ReadOffer( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Archive an existing offer. Please provide an `offer_id` in order to archive the correct item. + /// Archives an existing offer. Please provide an `offer_id` in order to archive the correct item. /// /// Required parameter: The Chargify id of the offer. public void ArchiveOffer( @@ -129,7 +129,7 @@ public void ArchiveOffer( => CoreHelper.RunVoidTask(ArchiveOfferAsync(offerId)); /// - /// Archive an existing offer. Please provide an `offer_id` in order to archive the correct item. + /// Archives an existing offer. Please provide an `offer_id` in order to archive the correct item. /// /// Required parameter: The Chargify id of the offer. /// cancellationToken. @@ -146,7 +146,7 @@ public async Task ArchiveOfferAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Unarchive a previously archived offer. Please provide an `offer_id` in order to un-archive the correct item. + /// Unarchives a previously archived offer. Please provide an `offer_id` in order to unarchive the correct item. /// /// Required parameter: The Chargify id of the offer. public void UnarchiveOffer( @@ -154,7 +154,7 @@ public void UnarchiveOffer( => CoreHelper.RunVoidTask(UnarchiveOfferAsync(offerId)); /// - /// Unarchive a previously archived offer. Please provide an `offer_id` in order to un-archive the correct item. + /// Unarchives a previously archived offer. Please provide an `offer_id` in order to unarchive the correct item. /// /// Required parameter: The Chargify id of the offer. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/PaymentProfilesController.cs b/AdvancedBilling.Standard/Controllers/PaymentProfilesController.cs index 43a5b685..13f9aa82 100644 --- a/AdvancedBilling.Standard/Controllers/PaymentProfilesController.cs +++ b/AdvancedBilling.Standard/Controllers/PaymentProfilesController.cs @@ -25,66 +25,30 @@ public class PaymentProfilesController : BaseController internal PaymentProfilesController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Optional parameter: When following the IBAN or the Local Bank details examples, a customer, bank account and mandate will be created in your current vault. If the customer, bank account, and mandate already exist in your vault, follow the Import example to link the payment profile into Advanced Billing.. /// Returns the Models.PaymentProfileResponse response from the API call. @@ -93,66 +57,30 @@ public Models.PaymentProfileResponse CreatePaymentProfile( => CoreHelper.RunTask(CreatePaymentProfileAsync(body)); /// - /// + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Optional parameter: When following the IBAN or the Local Bank details examples, a customer, bank account and mandate will be created in your current vault. If the customer, bank account, and mandate already exist in your vault, follow the Import example to link the payment profile into Advanced Billing.. /// cancellationToken. @@ -173,7 +101,7 @@ public Models.PaymentProfileResponse CreatePaymentProfile( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method will return all of the active `payment_profiles` for a Site, or for one Customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. + /// Returns all active payment profiles for a site, or for one customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. /// /// Object containing request parameters. /// Returns the List of Models.PaymentProfileResponse response from the API call. @@ -182,7 +110,7 @@ public Models.PaymentProfileResponse CreatePaymentProfile( => CoreHelper.RunTask(ListPaymentProfilesAsync(input)); /// - /// This method will return all of the active `payment_profiles` for a Site, or for one Customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. + /// Returns all active payment profiles for a site, or for one customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. /// /// Object containing request parameters. /// cancellationToken. @@ -201,7 +129,7 @@ public Models.PaymentProfileResponse CreatePaymentProfile( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Using the GET method you can retrieve a Payment Profile identified by its unique ID. + /// Returns a payment profile identified by its unique ID. /// Note that a different JSON object will be returned if the card method on file is a bank account. /// ### Response for Bank Account. /// Example response for Bank Account:. @@ -242,7 +170,7 @@ public Models.PaymentProfileResponse ReadPaymentProfile( => CoreHelper.RunTask(ReadPaymentProfileAsync(paymentProfileId)); /// - /// Using the GET method you can retrieve a Payment Profile identified by its unique ID. + /// Returns a payment profile identified by its unique ID. /// Note that a different JSON object will be returned if the card method on file is a bank account. /// ### Response for Bank Account. /// Example response for Bank Account:. @@ -293,6 +221,7 @@ public Models.PaymentProfileResponse ReadPaymentProfile( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// + /// Updates a payment profile. /// ## 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 this case, the following JSON is acceptable:. @@ -327,6 +256,7 @@ public Models.PaymentProfileResponse UpdatePaymentProfile( => CoreHelper.RunTask(UpdatePaymentProfileAsync(paymentProfileId, body)); /// + /// Updates a payment profile. /// ## 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 this case, the following JSON is acceptable:. @@ -438,7 +368,7 @@ public async Task DeleteSubscriptionsPaymentProfileAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Submit the two small deposit amounts the customer received in their bank account in order to verify the bank account. (Stripe only). + /// Verifies a bank account. Submit the two small deposit amounts the customer received in their bank account to verify the bank account. (Stripe only). /// /// Required parameter: Identifier of the bank account in the system.. /// Optional parameter: . @@ -449,7 +379,7 @@ public Models.BankAccountResponse VerifyBankAccount( => CoreHelper.RunTask(VerifyBankAccountAsync(bankAccountId, body)); /// - /// Submit the two small deposit amounts the customer received in their bank account in order to verify the bank account. (Stripe only). + /// Verifies a bank account. Submit the two small deposit amounts the customer received in their bank account to verify the bank account. (Stripe only). /// /// Required parameter: Identifier of the bank account in the system.. /// Optional parameter: . @@ -505,7 +435,7 @@ public async Task DeleteSubscriptionGroupPaymentProfileAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This will change the default payment profile on the subscription to the existing payment profile with the id specified. + /// Changes the default payment profile on the subscription to the existing payment profile with the specified ID. /// 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. /// /// Required parameter: The Chargify id of the subscription.. @@ -517,7 +447,7 @@ public Models.PaymentProfileResponse ChangeSubscriptionDefaultPaymentProfile( => CoreHelper.RunTask(ChangeSubscriptionDefaultPaymentProfileAsync(subscriptionId, paymentProfileId)); /// - /// This will change the default payment profile on the subscription to the existing payment profile with the id specified. + /// Changes the default payment profile on the subscription to the existing payment profile with the specified ID. /// 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. /// /// Required parameter: The Chargify id of the subscription.. diff --git a/AdvancedBilling.Standard/Controllers/ProductFamiliesController.cs b/AdvancedBilling.Standard/Controllers/ProductFamiliesController.cs index 5cb66e1b..d0f5c8c5 100644 --- a/AdvancedBilling.Standard/Controllers/ProductFamiliesController.cs +++ b/AdvancedBilling.Standard/Controllers/ProductFamiliesController.cs @@ -62,7 +62,7 @@ internal ProductFamiliesController(GlobalConfiguration globalConfiguration) : ba .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components and coupons. + /// Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components, and coupons. /// Full documentation on how Product Families operate within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families). /// /// Optional parameter: . @@ -72,7 +72,7 @@ public Models.ProductFamilyResponse CreateProductFamily( => CoreHelper.RunTask(CreateProductFamilyAsync(body)); /// - /// Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components and coupons. + /// Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components, and coupons. /// Full documentation on how Product Families operate within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families). /// /// Optional parameter: . @@ -93,7 +93,7 @@ public Models.ProductFamilyResponse CreateProductFamily( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Retrieve a list of Product Families for a site. + /// Returns a list of Product Families for a site. /// /// Object containing request parameters. /// Returns the List of Models.ProductFamilyResponse response from the API call. @@ -102,7 +102,7 @@ public Models.ProductFamilyResponse CreateProductFamily( => CoreHelper.RunTask(ListProductFamiliesAsync(input)); /// - /// Retrieve a list of Product Families for a site. + /// Returns a list of Product Families for a site. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/ProductPricePointsController.cs b/AdvancedBilling.Standard/Controllers/ProductPricePointsController.cs index 53a9201c..e2a0132e 100644 --- a/AdvancedBilling.Standard/Controllers/ProductPricePointsController.cs +++ b/AdvancedBilling.Standard/Controllers/ProductPricePointsController.cs @@ -129,7 +129,7 @@ public Models.ProductPricePointResponse UpdateProductPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to retrieve details for a specific product price point. You can achieve this by using either the product price point ID or handle. + /// Returns details for a specific product price point. You can achieve this by using either the product price point ID or handle. /// /// Required parameter: The id or handle of the product. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-price-point-handle` for a string handle.. @@ -142,7 +142,7 @@ public Models.ProductPricePointResponse ReadProductPricePoint( => CoreHelper.RunTask(ReadProductPricePointAsync(productId, pricePointId, currencyPrices)); /// - /// Use this endpoint to retrieve details for a specific product price point. You can achieve this by using either the product price point ID or handle. + /// Returns details for a specific product price point. You can achieve this by using either the product price point ID or handle. /// /// Required parameter: The id or handle of the product. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-handle` for a string handle.. /// Required parameter: The id or handle of the price point. When using the handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or `handle:example-product-price-point-handle` for a string handle.. @@ -198,7 +198,7 @@ public Models.ProductPricePointResponse ArchiveProductPricePoint( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to unarchive an archived product price point. + /// Unarchives an archived product price point. /// /// Required parameter: The Advanced Billing id of the product to which the price point belongs. /// Required parameter: The Advanced Billing id of the product price point. @@ -209,7 +209,7 @@ public Models.ProductPricePointResponse UnarchiveProductPricePoint( => CoreHelper.RunTask(UnarchiveProductPricePointAsync(productId, pricePointId)); /// - /// Use this endpoint to unarchive an archived product price point. + /// Unarchives an archived product price point. /// /// Required parameter: The Advanced Billing id of the product to which the price point belongs. /// Required parameter: The Advanced Billing id of the product price point. @@ -372,7 +372,7 @@ public Models.CurrencyPricesResponse UpdateProductCurrencyPrices( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows retrieval of a list of Products Price Points belonging to a Site. + /// Lists Product Price Points belonging to a site. /// /// Object containing request parameters. /// Returns the Models.ListProductPricePointsResponse response from the API call. @@ -381,7 +381,7 @@ public Models.ListProductPricePointsResponse ListAllProductPricePoints( => CoreHelper.RunTask(ListAllProductPricePointsAsync(input)); /// - /// This method allows retrieval of a list of Products Price Points belonging to a Site. + /// Lists Product Price Points belonging to a site. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/ProductsController.cs b/AdvancedBilling.Standard/Controllers/ProductsController.cs index 9f3978a5..da5be227 100644 --- a/AdvancedBilling.Standard/Controllers/ProductsController.cs +++ b/AdvancedBilling.Standard/Controllers/ProductsController.cs @@ -25,7 +25,7 @@ internal ProductsController(GlobalConfiguration globalConfiguration) : base(glob /// /// Creates a product in your Advanced Billing site. - /// See the following product docuemation for more information:. + /// See the following product documentation for more information:. /// + [Products Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-Products-Overview). /// + [Changing a Subscription's Product](https://maxio.zendesk.com/hc/en-us/articles/24252069837581-Product-Changes-and-Migrations). /// @@ -39,7 +39,7 @@ public Models.ProductResponse CreateProduct( /// /// Creates a product in your Advanced Billing site. - /// See the following product docuemation for more information:. + /// See the following product documentation for more information:. /// + [Products Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-Products-Overview). /// + [Changing a Subscription's Product](https://maxio.zendesk.com/hc/en-us/articles/24252069837581-Product-Changes-and-Migrations). /// @@ -132,7 +132,7 @@ public Models.ProductResponse UpdateProduct( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Archives the product. All current subscribers will be unffected; their subscription/purchase will continue to be charged monthly. + /// Archives the product. All current subscribers will be unaffected; their subscription/purchase will continue to be charged monthly. /// 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. /// /// Required parameter: The Advanced Billing id of the product. @@ -142,7 +142,7 @@ public Models.ProductResponse ArchiveProduct( => CoreHelper.RunTask(ArchiveProductAsync(productId)); /// - /// Archives the product. All current subscribers will be unffected; their subscription/purchase will continue to be charged monthly. + /// Archives the product. All current subscribers will be unaffected; their subscription/purchase will continue to be charged monthly. /// 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. /// /// Required parameter: The Advanced Billing id of the product. @@ -188,7 +188,7 @@ public Models.ProductResponse ReadProductByHandle( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method allows to retrieve a list of Products belonging to a Site. + /// Lists products belonging to a site. /// /// Object containing request parameters. /// Returns the List of Models.ProductResponse response from the API call. @@ -197,7 +197,7 @@ public Models.ProductResponse ReadProductByHandle( => CoreHelper.RunTask(ListProductsAsync(input)); /// - /// This method allows to retrieve a list of Products belonging to a Site. + /// Lists products belonging to a site. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/ProformaInvoicesController.cs b/AdvancedBilling.Standard/Controllers/ProformaInvoicesController.cs index 9f5480f2..d90828e3 100644 --- a/AdvancedBilling.Standard/Controllers/ProformaInvoicesController.cs +++ b/AdvancedBilling.Standard/Controllers/ProformaInvoicesController.cs @@ -24,7 +24,7 @@ public class ProformaInvoicesController : BaseController internal ProformaInvoicesController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// This endpoint will trigger the creation of a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. + /// Creates a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. /// If the information becomes outdated, simply void the old consolidated proforma invoice and generate a new one. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. To create a proforma invoice, the subscription must not be prepaid, and must be in a live state. @@ -35,7 +35,7 @@ public void CreateConsolidatedProformaInvoice( => CoreHelper.RunVoidTask(CreateConsolidatedProformaInvoiceAsync(uid)); /// - /// This endpoint will trigger the creation of a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. + /// Creates a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. /// If the information becomes outdated, simply void the old consolidated proforma invoice and generate a new one. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. To create a proforma invoice, the subscription must not be prepaid, and must be in a live state. @@ -57,7 +57,7 @@ public async Task CreateConsolidatedProformaInvoiceAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Only proforma invoices with a `consolidation_level` of parent are returned. + /// Lists proforma invoices with a `consolidation_level` of parent for the subscription group. /// By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to true. /// /// Object containing request parameters. @@ -67,7 +67,7 @@ public Models.ListProformaInvoicesResponse ListSubscriptionGroupProformaInvoices => CoreHelper.RunTask(ListSubscriptionGroupProformaInvoicesAsync(input)); /// - /// Only proforma invoices with a `consolidation_level` of parent are returned. + /// Lists proforma invoices with a `consolidation_level` of parent for the subscription group. /// By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to true. /// /// Object containing request parameters. @@ -93,7 +93,7 @@ public Models.ListProformaInvoicesResponse ListSubscriptionGroupProformaInvoices .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to read the details of an existing proforma invoice. + /// Returns the details of an existing proforma invoice. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. /// @@ -104,7 +104,7 @@ public Models.ProformaInvoice ReadProformaInvoice( => CoreHelper.RunTask(ReadProformaInvoiceAsync(proformaInvoiceUid)); /// - /// Use this endpoint to read the details of an existing proforma invoice. + /// Returns the details of an existing proforma invoice. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. /// @@ -125,7 +125,7 @@ public Models.ProformaInvoice ReadProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will create a proforma invoice and return it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. + /// Creates a proforma invoice and returns it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. /// If you would like to preview the next billing amounts without generating a full proforma invoice, use the renewal preview endpoint. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. To create a proforma invoice, the subscription must not be in a group, must not be prepaid, and must be in a live state. @@ -137,7 +137,7 @@ public Models.ProformaInvoice CreateProformaInvoice( => CoreHelper.RunTask(CreateProformaInvoiceAsync(subscriptionId)); /// - /// This endpoint will create a proforma invoice and return it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. + /// Creates a proforma invoice and returns it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. /// If you would like to preview the next billing amounts without generating a full proforma invoice, use the renewal preview endpoint. /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. To create a proforma invoice, the subscription must not be in a group, must not be prepaid, and must be in a live state. @@ -159,7 +159,7 @@ public Models.ProformaInvoice CreateProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. + /// Lists proforma invoices for a subscription. By default, results only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. /// /// Object containing request parameters. /// Returns the Models.ListProformaInvoicesResponse response from the API call. @@ -168,7 +168,7 @@ public Models.ListProformaInvoicesResponse ListProformaInvoices( => CoreHelper.RunTask(ListProformaInvoicesAsync(input)); /// - /// By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. + /// Lists proforma invoices for a subscription. By default, results only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. /// /// Object containing request parameters. /// cancellationToken. @@ -197,7 +197,7 @@ public Models.ListProformaInvoicesResponse ListProformaInvoices( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Allows for proforma invoices to be programmatically delivered via email. Supports email. + /// Delivers a proforma invoice programmatically via email. Supports email. /// delivery to direct recipients, carbon-copy (cc) recipients, and blind carbon-copy (bcc) recipients. /// If `recipient_emails` is omitted, the system will fall back to the primary recipient derived from the invoice or. /// subscription. At least one recipient must be present, either via the request body or via this default behavior, so an. @@ -212,7 +212,7 @@ public Models.ProformaInvoice DeliverProformaInvoice( => CoreHelper.RunTask(DeliverProformaInvoiceAsync(proformaInvoiceUid, body)); /// - /// Allows for proforma invoices to be programmatically delivered via email. Supports email. + /// Delivers a proforma invoice programmatically via email. Supports email. /// delivery to direct recipients, carbon-copy (cc) recipients, and blind carbon-copy (bcc) recipients. /// If `recipient_emails` is omitted, the system will fall back to the primary recipient derived from the invoice or. /// subscription. At least one recipient must be present, either via the request body or via this default behavior, so an. @@ -240,7 +240,7 @@ public Models.ProformaInvoice DeliverProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will void a proforma invoice that has the status "draft". + /// Voids a proforma invoice that has the status "draft". /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. /// Only proforma invoices that have the appropriate status may be reopened. If the invoice identified by {uid} does not have the appropriate status, the response will have HTTP status code 422 and an error message. @@ -255,7 +255,7 @@ public Models.ProformaInvoice VoidProformaInvoice( => CoreHelper.RunTask(VoidProformaInvoiceAsync(proformaInvoiceUid, body)); /// - /// This endpoint will void a proforma invoice that has the status "draft". + /// Voids a proforma invoice that has the status "draft". /// ## Restrictions. /// Proforma invoices are only available on Relationship Invoicing sites. /// Only proforma invoices that have the appropriate status may be reopened. If the invoice identified by {uid} does not have the appropriate status, the response will have HTTP status code 422 and an error message. @@ -283,7 +283,7 @@ public Models.ProformaInvoice VoidProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Return a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. + /// Returns a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. /// The preview endpoint is subject to all the same conditions as the proforma invoice endpoint. For example, previews are only available on the Relationship Invoicing architecture, and previews cannot be made for end-of-life subscriptions. /// If all the data returned in the preview is as expected, you may then create a static proforma invoice and send it to your customer. The data within a preview will not be saved and will not be accessible after the call is made. /// Alternatively, if you have some proforma invoices already, you may make a preview call to determine whether any billing information for the subscription's upcoming renewal has changed. @@ -295,7 +295,7 @@ public Models.ProformaInvoice PreviewProformaInvoice( => CoreHelper.RunTask(PreviewProformaInvoiceAsync(subscriptionId)); /// - /// Return a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. + /// Returns a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. /// The preview endpoint is subject to all the same conditions as the proforma invoice endpoint. For example, previews are only available on the Relationship Invoicing architecture, and previews cannot be made for end-of-life subscriptions. /// If all the data returned in the preview is as expected, you may then create a static proforma invoice and send it to your customer. The data within a preview will not be saved and will not be accessible after the call is made. /// Alternatively, if you have some proforma invoices already, you may make a preview call to determine whether any billing information for the subscription's upcoming renewal has changed. @@ -318,8 +318,7 @@ public Models.ProformaInvoice PreviewProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. - /// Create a proforma invoice to preview costs before a subscription's signup. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. + /// Creates a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. /// Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. /// A product and customer first name, last name, and email are the minimum requirements. We recommend associating the proforma invoice with a customer_id to easily find their proforma invoices, since the subscription_id will always be blank. /// @@ -330,8 +329,7 @@ public Models.ProformaInvoice CreateSignupProformaInvoice( => CoreHelper.RunTask(CreateSignupProformaInvoiceAsync(body)); /// - /// This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. - /// Create a proforma invoice to preview costs before a subscription's signup. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. + /// Creates a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. /// Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. /// A product and customer first name, last name, and email are the minimum requirements. We recommend associating the proforma invoice with a customer_id to easily find their proforma invoices, since the subscription_id will always be blank. /// @@ -354,8 +352,7 @@ public Models.ProformaInvoice CreateSignupProformaInvoice( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. - /// Create a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. You have the option of optionally previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. + /// Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. You have the option of previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. /// Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. /// A product and customer first name, last name, and email are the minimum requirements. /// @@ -368,8 +365,7 @@ public Models.SignupProformaPreviewResponse PreviewSignupProformaInvoice( => CoreHelper.RunTask(PreviewSignupProformaInvoiceAsync(include, body)); /// - /// This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. - /// Create a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. You have the option of optionally previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. + /// Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. You have the option of previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. /// Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. /// A product and customer first name, last name, and email are the minimum requirements. /// diff --git a/AdvancedBilling.Standard/Controllers/ReasonCodesController.cs b/AdvancedBilling.Standard/Controllers/ReasonCodesController.cs index 07e406bb..27fb28d6 100644 --- a/AdvancedBilling.Standard/Controllers/ReasonCodesController.cs +++ b/AdvancedBilling.Standard/Controllers/ReasonCodesController.cs @@ -24,14 +24,15 @@ public class ReasonCodesController : BaseController internal ReasonCodesController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// + /// Creates a reason code for a given site. /// # Reason Codes Intro. - /// ReasonCodes are a way to gain a high level view of why your customers are cancelling the subscription to your product or service. + /// Reason Codes are a way to gain a high-level view of why your customers are cancelling the subscription to your product or service. /// Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. /// ## Reason Code Documentation. /// Full documentation on how Reason Codes operate within Advanced Billing can be located under the following links. /// [Churn Reason Codes](https://maxio.zendesk.com/hc/en-us/articles/24286647554701-Churn-Reason-Codes). /// ## Create Reason Code. - /// This method gives a merchant the option to create a reason codes for a given Site. + /// This method gives a merchant the option to create reason codes for a given site. /// /// Optional parameter: . /// Returns the Models.ReasonCodeResponse response from the API call. @@ -40,14 +41,15 @@ public Models.ReasonCodeResponse CreateReasonCode( => CoreHelper.RunTask(CreateReasonCodeAsync(body)); /// + /// Creates a reason code for a given site. /// # Reason Codes Intro. - /// ReasonCodes are a way to gain a high level view of why your customers are cancelling the subscription to your product or service. + /// Reason Codes are a way to gain a high-level view of why your customers are cancelling the subscription to your product or service. /// Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. /// ## Reason Code Documentation. /// Full documentation on how Reason Codes operate within Advanced Billing can be located under the following links. /// [Churn Reason Codes](https://maxio.zendesk.com/hc/en-us/articles/24286647554701-Churn-Reason-Codes). /// ## Create Reason Code. - /// This method gives a merchant the option to create a reason codes for a given Site. + /// This method gives a merchant the option to create reason codes for a given site. /// /// Optional parameter: . /// cancellationToken. @@ -67,7 +69,7 @@ public Models.ReasonCodeResponse CreateReasonCode( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method gives a merchant the option to retrieve a list of all of the current churn codes for a given site. + /// Lists all current churn codes for a given site. /// /// Object containing request parameters. /// Returns the List of Models.ReasonCodeResponse response from the API call. @@ -76,7 +78,7 @@ public Models.ReasonCodeResponse CreateReasonCode( => CoreHelper.RunTask(ListReasonCodesAsync(input)); /// - /// This method gives a merchant the option to retrieve a list of all of the current churn codes for a given site. + /// Lists all current churn codes for a given site. /// /// Object containing request parameters. /// cancellationToken. @@ -96,7 +98,7 @@ public Models.ReasonCodeResponse CreateReasonCode( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method gives a merchant the option to retrieve a list of a particular code for a given Site by providing the unique numerical ID of the code. + /// Returns a particular churn reason code for a given site by its unique ID. /// /// Required parameter: The Advanced Billing id of the reason code. /// Returns the Models.ReasonCodeResponse response from the API call. @@ -105,7 +107,7 @@ public Models.ReasonCodeResponse ReadReasonCode( => CoreHelper.RunTask(ReadReasonCodeAsync(reasonCodeId)); /// - /// This method gives a merchant the option to retrieve a list of a particular code for a given Site by providing the unique numerical ID of the code. + /// Returns a particular churn reason code for a given site by its unique ID. /// /// Required parameter: The Advanced Billing id of the reason code. /// cancellationToken. @@ -124,7 +126,7 @@ public Models.ReasonCodeResponse ReadReasonCode( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method gives a merchant the option to update an existing reason code for a given site. + /// Updates an existing reason code for a given site. /// /// Required parameter: The Advanced Billing id of the reason code. /// Optional parameter: . @@ -135,7 +137,7 @@ public Models.ReasonCodeResponse UpdateReasonCode( => CoreHelper.RunTask(UpdateReasonCodeAsync(reasonCodeId, body)); /// - /// This method gives a merchant the option to update an existing reason code for a given site. + /// Updates an existing reason code for a given site. /// /// Required parameter: The Advanced Billing id of the reason code. /// Optional parameter: . @@ -159,7 +161,7 @@ public Models.ReasonCodeResponse UpdateReasonCode( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. + /// Deletes a reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. /// /// Required parameter: The Advanced Billing id of the reason code. /// Returns the Models.OkResponse response from the API call. @@ -168,7 +170,7 @@ public Models.OkResponse DeleteReasonCode( => CoreHelper.RunTask(DeleteReasonCodeAsync(reasonCodeId)); /// - /// This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. + /// Deletes a reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. /// /// Required parameter: The Advanced Billing id of the reason code. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/ReferralCodesController.cs b/AdvancedBilling.Standard/Controllers/ReferralCodesController.cs index 49276a9b..21770711 100644 --- a/AdvancedBilling.Standard/Controllers/ReferralCodesController.cs +++ b/AdvancedBilling.Standard/Controllers/ReferralCodesController.cs @@ -23,7 +23,7 @@ public class ReferralCodesController : BaseController internal ReferralCodesController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Use this method to determine if the referral code is valid and applicable within your Site. This method is useful for validating referral codes that are entered by a customer. + /// Validates whether a referral code is valid and applicable within your site. This method is useful for validating referral codes that are entered by a customer. /// ## Referrals Documentation. /// Full documentation on how to use the referrals feature in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referrals). /// ## Server Response. @@ -36,7 +36,7 @@ public Models.ReferralValidationResponse ValidateReferralCode( => CoreHelper.RunTask(ValidateReferralCodeAsync(code)); /// - /// Use this method to determine if the referral code is valid and applicable within your Site. This method is useful for validating referral codes that are entered by a customer. + /// Validates whether a referral code is valid and applicable within your site. This method is useful for validating referral codes that are entered by a customer. /// ## Referrals Documentation. /// Full documentation on how to use the referrals feature in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referrals). /// ## Server Response. diff --git a/AdvancedBilling.Standard/Controllers/SalesCommissionsController.cs b/AdvancedBilling.Standard/Controllers/SalesCommissionsController.cs index 4bf9ef6e..14f4e883 100644 --- a/AdvancedBilling.Standard/Controllers/SalesCommissionsController.cs +++ b/AdvancedBilling.Standard/Controllers/SalesCommissionsController.cs @@ -24,7 +24,7 @@ internal SalesCommissionsController(GlobalConfiguration globalConfiguration) : b /// /// /// /// /// /// /// /// /// - /// This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. + /// Clears all data from a test site asynchronously. This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. /// **This functionality will only work on sites in TEST mode. Attempts to perform this on sites in “live” mode will result in a response of 403 FORBIDDEN.**. /// /// Optional parameter: `all`: Will clear all products, customers, and related subscriptions from the site. `customers`: Will clear only customers and related subscriptions (leaving the products untouched) for the site. Revenue will also be reset to 0. Use in query `cleanup_scope=all`.. @@ -73,7 +73,7 @@ public void ClearSite( => CoreHelper.RunVoidTask(ClearSiteAsync(cleanupScope)); /// - /// This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. + /// Clears all data from a test site asynchronously. This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. /// **This functionality will only work on sites in TEST mode. Attempts to perform this on sites in “live” mode will result in a response of 403 FORBIDDEN.**. /// /// Optional parameter: `all`: Will clear all products, customers, and related subscriptions from the site. `customers`: Will clear only customers and related subscriptions (leaving the products untouched) for the site. Revenue will also be reset to 0. Use in query `cleanup_scope=all`.. @@ -91,7 +91,7 @@ public async Task ClearSiteAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint returns public keys used for Chargify.js. + /// Returns public keys used for Maxio.js (formerly Chargify.js). /// /// Object containing request parameters. /// Returns the Models.ListPublicKeysResponse response from the API call. @@ -100,7 +100,7 @@ public Models.ListPublicKeysResponse ListChargifyJsPublicKeys( => CoreHelper.RunTask(ListChargifyJsPublicKeysAsync(input)); /// - /// This endpoint returns public keys used for Chargify.js. + /// Returns public keys used for Maxio.js (formerly Chargify.js). /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionComponentsController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionComponentsController.cs index 1d17decb..5d447c4c 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionComponentsController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionComponentsController.cs @@ -27,7 +27,7 @@ public class SubscriptionComponentsController : BaseController internal SubscriptionComponentsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// This request will list information regarding a specific component owned by a subscription. + /// Returns information for a specific component on a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the component. Alternatively, the component's handle prefixed by `handle:`. @@ -38,7 +38,7 @@ public Models.SubscriptionComponentResponse ReadSubscriptionComponent( => CoreHelper.RunTask(ReadSubscriptionComponentAsync(subscriptionId, componentId)); /// - /// This request will list information regarding a specific component owned by a subscription. + /// Returns information for a specific component on a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the component. Alternatively, the component's handle prefixed by `handle:`. @@ -60,7 +60,7 @@ public Models.SubscriptionComponentResponse ReadSubscriptionComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will list a subscription's applied components. + /// Lists a subscription's applied components. /// ## Archived Components. /// When requesting to list components for a given subscription, if the subscription contains **archived** components they will be listed in the server response. /// @@ -71,7 +71,7 @@ public Models.SubscriptionComponentResponse ReadSubscriptionComponent( => CoreHelper.RunTask(ListSubscriptionComponentsAsync(input)); /// - /// This request will list a subscription's applied components. + /// Lists a subscription's applied components. /// ## Archived Components. /// When requesting to list components for a given subscription, if the subscription contains **archived** components they will be listed in the server response. /// @@ -174,7 +174,7 @@ public Models.SubscriptionResponse BulkResetSubscriptionComponentsPricePoints( /// /// Creates an allocation, sets the current allocated quantity for the component, and records a memo. Allocations can only be updated for Quantity, On/Off, and Prepaid Components. /// When creating an allocation via the API, you can pass the `upgrade_charge`, `downgrade_credit`, and `accrue_charge` to be applied. - /// > **Note:** These proration and accural fields are ignored for Prepaid Components since this component type always generate charges immediately without proration. + /// > **Note:** These proration and accrual fields are ignored for Prepaid Components since this component type always generates charges immediately without proration. /// For information on prorated components and upgrade/downgrade schemes, see [Setting Component Allocations.](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration). /// ### Order of Resolution for upgrade_charge and downgrade_credit. /// 1. Per allocation in API call (within a single allocation of the `allocations` array). @@ -185,7 +185,7 @@ public Models.SubscriptionResponse BulkResetSubscriptionComponentsPricePoints( /// 1. Allocation API call top level (outside of the `allocations` array). /// 2. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration#proration-schemes). /// > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. - /// For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. + /// For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the component. @@ -200,7 +200,7 @@ public Models.AllocationResponse AllocateComponent( /// /// Creates an allocation, sets the current allocated quantity for the component, and records a memo. Allocations can only be updated for Quantity, On/Off, and Prepaid Components. /// When creating an allocation via the API, you can pass the `upgrade_charge`, `downgrade_credit`, and `accrue_charge` to be applied. - /// > **Note:** These proration and accural fields are ignored for Prepaid Components since this component type always generate charges immediately without proration. + /// > **Note:** These proration and accrual fields are ignored for Prepaid Components since this component type always generates charges immediately without proration. /// For information on prorated components and upgrade/downgrade schemes, see [Setting Component Allocations.](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration). /// ### Order of Resolution for upgrade_charge and downgrade_credit. /// 1. Per allocation in API call (within a single allocation of the `allocations` array). @@ -211,7 +211,7 @@ public Models.AllocationResponse AllocateComponent( /// 1. Allocation API call top level (outside of the `allocations` array). /// 2. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration#proration-schemes). /// > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. - /// For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. + /// For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the component. @@ -237,7 +237,7 @@ public Models.AllocationResponse AllocateComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint returns the 50 most recent Allocations, ordered by most recent first. + /// Returns the 50 most recent Allocations, ordered by most recent first. /// ## On/Off Components. /// When a subscription's on/off component has been toggled to on (`1`) or off (`0`), usage will be logged in this response. /// @@ -252,7 +252,7 @@ public Models.AllocationResponse AllocateComponent( => CoreHelper.RunTask(ListAllocationsAsync(subscriptionId, componentId, page)); /// - /// This endpoint returns the 50 most recent Allocations, ordered by most recent first. + /// Returns the 50 most recent Allocations, ordered by most recent first. /// ## On/Off Components. /// When a subscription's on/off component has been toggled to on (`1`) or off (`0`), usage will be logged in this response. /// @@ -280,7 +280,7 @@ public Models.AllocationResponse AllocateComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Creates multiple allocations, sets the current allocated quantity for each of the components, and recording a memo. A `component_id` is required for each allocation. + /// Creates multiple allocations, sets the current allocated quantity for each of the components, and records a memo. A `component_id` is required for each allocation. /// The charges and/or credits that are created will be rolled up into a single total which is used to determine whether this is an upgrade or a downgrade. /// ### Order of Resolution for upgrade_charge and downgrade_credit. /// 1. Per allocation in API call (within a single allocation of the `allocations` array). @@ -291,7 +291,7 @@ public Models.AllocationResponse AllocateComponent( /// 1. Allocation API call top level (outside of the `allocations` array). /// 2. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration#proration-schemes). /// > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. - /// For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. + /// For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product documentation. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -302,7 +302,7 @@ public Models.AllocationResponse AllocateComponent( => CoreHelper.RunTask(AllocateComponentsAsync(subscriptionId, body)); /// - /// Creates multiple allocations, sets the current allocated quantity for each of the components, and recording a memo. A `component_id` is required for each allocation. + /// Creates multiple allocations, sets the current allocated quantity for each of the components, and records a memo. A `component_id` is required for each allocation. /// The charges and/or credits that are created will be rolled up into a single total which is used to determine whether this is an upgrade or a downgrade. /// ### Order of Resolution for upgrade_charge and downgrade_credit. /// 1. Per allocation in API call (within a single allocation of the `allocations` array). @@ -313,7 +313,7 @@ public Models.AllocationResponse AllocateComponent( /// 1. Allocation API call top level (outside of the `allocations` array). /// 2. [Site-level default value](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration#proration-schemes). /// > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. - /// For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. + /// For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product documentation. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -337,7 +337,7 @@ public Models.AllocationResponse AllocateComponent( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Advanced Billing offers the ability to preview a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. + /// Previews a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. /// ## Fine-grained Component Control: Use with multiple `upgrade_charge`s or `downgrade_credits`. /// When the allocation uses multiple different types of `upgrade_charge`s or `downgrade_credit`s, the Allocation is viewed as an Allocation which uses "Fine-Grained Component Control". As a result, the response will not include `direction` and `proration` within the `allocation_preview`, but at the `line_items` and `allocations` level respectfully. /// See example below for Fine-Grained Component Control response. @@ -351,7 +351,7 @@ public Models.AllocationPreviewResponse PreviewAllocations( => CoreHelper.RunTask(PreviewAllocationsAsync(subscriptionId, body)); /// - /// Advanced Billing offers the ability to preview a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. + /// Previews a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. /// ## Fine-grained Component Control: Use with multiple `upgrade_charge`s or `downgrade_credits`. /// When the allocation uses multiple different types of `upgrade_charge`s or `downgrade_credit`s, the Allocation is viewed as an Allocation which uses "Fine-Grained Component Control". As a result, the response will not include `direction` and `proration` within the `allocation_preview`, but at the `line_items` and `allocations` level respectfully. /// See example below for Fine-Grained Component Control response. @@ -377,7 +377,7 @@ public Models.AllocationPreviewResponse PreviewAllocations( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// When the expiration interval options are selected on a prepaid usage component price point, all allocations will be created with an expiration date. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. + /// Updates the expiration date for a prepaid usage allocation. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. /// In order to change a prepaid usage allocation's expiration date, a PUT call must be made to the allocation's endpoint with a new expiration date. /// ## Limitations. /// A few limitations exist when changing an allocation's expiration date:. @@ -397,7 +397,7 @@ public void UpdatePrepaidUsageAllocationExpirationDate( => CoreHelper.RunVoidTask(UpdatePrepaidUsageAllocationExpirationDateAsync(subscriptionId, componentId, allocationId, body)); /// - /// When the expiration interval options are selected on a prepaid usage component price point, all allocations will be created with an expiration date. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. + /// Updates the expiration date for a prepaid usage allocation. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. /// In order to change a prepaid usage allocation's expiration date, a PUT call must be made to the allocation's endpoint with a new expiration date. /// ## Limitations. /// A few limitations exist when changing an allocation's expiration date:. @@ -433,7 +433,8 @@ public async Task UpdatePrepaidUsageAllocationExpirationDateAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component each allocation must be destroyed individually via this endpoint. + /// Deletes a prepaid usage allocation. + /// Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component, each allocation must be destroyed individually via this endpoint. /// ## Credit Scheme. /// By default, destroying an allocation will generate a service credit on the subscription. This behavior can be modified with the optional `credit_scheme` parameter on this endpoint. The accepted values are:. /// 1. `none`: The allocation will be destroyed and the balances will be updated but no service credit or refund will be created. @@ -452,7 +453,8 @@ public void DeletePrepaidUsageAllocation( => CoreHelper.RunVoidTask(DeletePrepaidUsageAllocationAsync(subscriptionId, componentId, allocationId, body)); /// - /// Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component each allocation must be destroyed individually via this endpoint. + /// Deletes a prepaid usage allocation. + /// Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component, each allocation must be destroyed individually via this endpoint. /// ## Credit Scheme. /// By default, destroying an allocation will generate a service credit on the subscription. This behavior can be modified with the optional `credit_scheme` parameter on this endpoint. The accepted values are:. /// 1. `none`: The allocation will be destroyed and the balances will be updated but no service credit or refund will be created. @@ -490,9 +492,9 @@ public async Task DeletePrepaidUsageAllocationAsync( /// Records an instance of metered or prepaid usage for a subscription. /// You can report metered or prepaid usage to Advanced Billing as often as you wish. You can report usage as it happens or periodically, such as each night or once per billing period. . /// Full documentation on how to create Components in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). Additionally, for information on how to record component usage against a subscription, see the following resources:. - /// It is not possible to record metered usage for more than one component at a time Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. . - /// See the following product documention articles for more information:. - /// - [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). A. + /// It is not possible to record metered usage for more than one component at a time. Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. . + /// See the following product documentation articles for more information:. + /// - [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). /// - [Recording Metered Component Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-metered-component-usage). /// - [Reporting Prepaid Component Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-prepaid-component-status). /// The `quantity` from usage for each component is accumulated to the `unit_balance` on the [Component Line Item]($e/Subscription%20Components/readSubscriptionComponent) for the subscription. @@ -536,9 +538,9 @@ public Models.UsageResponse CreateUsage( /// Records an instance of metered or prepaid usage for a subscription. /// You can report metered or prepaid usage to Advanced Billing as often as you wish. You can report usage as it happens or periodically, such as each night or once per billing period. . /// Full documentation on how to create Components in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). Additionally, for information on how to record component usage against a subscription, see the following resources:. - /// It is not possible to record metered usage for more than one component at a time Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. . - /// See the following product documention articles for more information:. - /// - [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). A. + /// It is not possible to record metered usage for more than one component at a time. Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. . + /// See the following product documentation articles for more information:. + /// - [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). /// - [Recording Metered Component Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-metered-component-usage). /// - [Reporting Prepaid Component Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-prepaid-component-status). /// The `quantity` from usage for each component is accumulated to the `unit_balance` on the [Component Line Item]($e/Subscription%20Components/readSubscriptionComponent) for the subscription. @@ -593,7 +595,7 @@ public Models.UsageResponse CreateUsage( /// /// /// + /// Activates an event-based component for a single subscription. /// In order to bill your subscribers on your Events data under the Events-Based Billing feature, the components must be activated for the subscriber. /// Learn more about the role of activation in the [Events-Based Billing docs](https://maxio.zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). /// Use this endpoint to activate an event-based component for a single subscription. Activating an event-based component causes Advanced Billing to bill for events when the subscription is renewed. @@ -660,6 +663,7 @@ public void ActivateEventBasedComponent( => CoreHelper.RunVoidTask(ActivateEventBasedComponentAsync(subscriptionId, componentId, body)); /// + /// Activates an event-based component for a single subscription. /// In order to bill your subscribers on your Events data under the Events-Based Billing feature, the components must be activated for the subscriber. /// Learn more about the role of activation in the [Events-Based Billing docs](https://maxio.zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). /// Use this endpoint to activate an event-based component for a single subscription. Activating an event-based component causes Advanced Billing to bill for events when the subscription is renewed. @@ -687,7 +691,7 @@ public async Task ActivateEventBasedComponentAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. + /// Deactivates an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. /// /// Required parameter: The Advanced Billing id of the subscription. /// Required parameter: The Advanced Billing id of the component. @@ -697,7 +701,7 @@ public void DeactivateEventBasedComponent( => CoreHelper.RunVoidTask(DeactivateEventBasedComponentAsync(subscriptionId, componentId)); /// - /// Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. + /// Deactivates an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. /// /// Required parameter: The Advanced Billing id of the subscription. /// Required parameter: The Advanced Billing id of the component. @@ -717,6 +721,7 @@ public async Task DeactivateEventBasedComponentAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// + /// Records a single event for Events-Based Billing. /// ## Documentation. /// Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Advanced Billing. /// These events can then be transformed, enriched, or analyzed to form the computed totals of usage charges billed to your customers. @@ -739,6 +744,7 @@ public void RecordEvent( => CoreHelper.RunVoidTask(RecordEventAsync(apiHandle, storeUid, body)); /// + /// Records a single event for Events-Based Billing. /// ## Documentation. /// Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Advanced Billing. /// These events can then be transformed, enriched, or analyzed to form the computed totals of usage charges billed to your customers. @@ -774,7 +780,7 @@ public async Task RecordEventAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to record a collection of events. + /// Records a collection of events. /// *Note: this endpoint differs from the standard Chargify API endpoints in that the subdomain will be `events` and your site subdomain will be included in the URL path.*. /// A maximum of 1000 events can be published in a single request. A 422 will be returned if this limit is exceeded. /// @@ -788,7 +794,7 @@ public void BulkRecordEvents( => CoreHelper.RunVoidTask(BulkRecordEventsAsync(apiHandle, storeUid, body)); /// - /// Use this endpoint to record a collection of events. + /// Records a collection of events. /// *Note: this endpoint differs from the standard Chargify API endpoints in that the subdomain will be `events` and your site subdomain will be included in the URL path.*. /// A maximum of 1000 events can be published in a single request. A 422 will be returned if this limit is exceeded. /// @@ -815,7 +821,7 @@ public async Task BulkRecordEventsAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will list components applied to each subscription. + /// Lists components applied to each subscription. /// /// Object containing request parameters. /// Returns the Models.ListSubscriptionComponentsResponse response from the API call. @@ -824,7 +830,7 @@ public Models.ListSubscriptionComponentsResponse ListSubscriptionComponentsForSi => CoreHelper.RunTask(ListSubscriptionComponentsForSiteAsync(input)); /// - /// This request will list components applied to each subscription. + /// Lists components applied to each subscription. /// /// Object containing request parameters. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionGroupInvoiceAccountController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionGroupInvoiceAccountController.cs index 1aa55897..875255f0 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionGroupInvoiceAccountController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionGroupInvoiceAccountController.cs @@ -23,7 +23,7 @@ public class SubscriptionGroupInvoiceAccountController : BaseController internal SubscriptionGroupInvoiceAccountController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// A prepayment can be added for a subscription group identified by the group's `uid`. This endpoint requires a `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. + /// Adds a prepayment for a subscription group. This endpoint requires an `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -34,7 +34,7 @@ public Models.SubscriptionGroupPrepaymentResponse CreateSubscriptionGroupPrepaym => CoreHelper.RunTask(CreateSubscriptionGroupPrepaymentAsync(uid, body)); /// - /// A prepayment can be added for a subscription group identified by the group's `uid`. This endpoint requires a `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. + /// Adds a prepayment for a subscription group. This endpoint requires an `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -57,7 +57,7 @@ public Models.SubscriptionGroupPrepaymentResponse CreateSubscriptionGroupPrepaym .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will list a subscription group's prepayments. + /// Lists a subscription group's prepayments. /// /// Object containing request parameters. /// Returns the Models.ListSubscriptionGroupPrepaymentResponse response from the API call. @@ -66,7 +66,7 @@ public Models.ListSubscriptionGroupPrepaymentResponse ListPrepaymentsForSubscrip => CoreHelper.RunTask(ListPrepaymentsForSubscriptionGroupAsync(input)); /// - /// This request will list a subscription group's prepayments. + /// Lists a subscription group's prepayments. /// /// Object containing request parameters. /// cancellationToken. @@ -88,7 +88,7 @@ public Models.ListSubscriptionGroupPrepaymentResponse ListPrepaymentsForSubscrip .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Credit can be issued for a subscription group identified by the group's `uid`. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. + /// Issues service credit for a subscription group. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -99,7 +99,7 @@ public Models.ServiceCreditResponse IssueSubscriptionGroupServiceCredit( => CoreHelper.RunTask(IssueSubscriptionGroupServiceCreditAsync(uid, body)); /// - /// Credit can be issued for a subscription group identified by the group's `uid`. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. + /// Issues service credit for a subscription group. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -122,7 +122,7 @@ public Models.ServiceCreditResponse IssueSubscriptionGroupServiceCredit( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Credit can be deducted for a subscription group identified by the group's `uid`. Credit will be deducted from the group in the amount specified in the request body. + /// Deducts service credit for a subscription group. Credit will be deducted from the group in the amount specified in the request body. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -133,7 +133,7 @@ public Models.ServiceCredit DeductSubscriptionGroupServiceCredit( => CoreHelper.RunTask(DeductSubscriptionGroupServiceCreditAsync(uid, body)); /// - /// Credit can be deducted for a subscription group identified by the group's `uid`. Credit will be deducted from the group in the amount specified in the request body. + /// Deducts service credit for a subscription group. Credit will be deducted from the group in the amount specified in the request body. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionGroupStatusController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionGroupStatusController.cs index ab195478..eabdbc97 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionGroupStatusController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionGroupStatusController.cs @@ -59,7 +59,7 @@ public async Task CancelSubscriptionsInGroupAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will schedule all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. + /// Schedules all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. /// All subscriptions in the group must be on automatic billing in order to successfully cancel them, and the group must not be in a "past_due" state. /// /// Required parameter: The uid of the subscription group. @@ -68,7 +68,7 @@ public void InitiateDelayedCancellationForGroup( => CoreHelper.RunVoidTask(InitiateDelayedCancellationForGroupAsync(uid)); /// - /// This endpoint will schedule all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. + /// Schedules all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. /// All subscriptions in the group must be on automatic billing in order to successfully cancel them, and the group must not be in a "past_due" state. /// /// Required parameter: The uid of the subscription group. @@ -88,6 +88,7 @@ public async Task InitiateDelayedCancellationForGroupAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// + /// Removes the delayed cancellation on a subscription group. /// Removing the delayed cancellation on a subscription group will ensure that the subscriptions do not get canceled at the end of the period. The request will reset the `cancel_at_end_of_period` flag to false on each member in the group. /// /// Required parameter: The uid of the subscription group. @@ -96,6 +97,7 @@ public void CancelDelayedCancellationForGroup( => CoreHelper.RunVoidTask(CancelDelayedCancellationForGroupAsync(uid)); /// + /// Removes the delayed cancellation on a subscription group. /// Removing the delayed cancellation on a subscription group will ensure that the subscriptions do not get canceled at the end of the period. The request will reset the `cancel_at_end_of_period` flag to false on each member in the group. /// /// Required parameter: The uid of the subscription group. @@ -115,16 +117,19 @@ public async Task CancelDelayedCancellationForGroupAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will attempt to reactivate or resume a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. + /// Reactivates or resumes a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. /// Whether a subscription group is reactivated (a new billing period is created) or resumed (the current billing period is respected) will depend on the parameters that are sent with the request as well as the date of the request relative to the primary subscription's period. /// ## Reactivating within the current period. - /// If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period the `resume=true` option must be passed in request parameters. - /// An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed the request will return an error. + /// If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period, the `resume=true` option must be passed in request parameters. + /// An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed, the request will return an error. /// The `resume_members` option is ignored in this case. All eligible group members will be automatically resumed. /// ## Reactivating beyond the current period. /// In this case, a subscription group can only be reactivated with a new billing period. If the `resume=true` option is passed it will be ignored. /// Member subscriptions can have billing periods that are longer than the primary (e.g. a monthly primary with annual group members). If the primary subscription in a group cannot be reactivated within the current period, but other group members can be, passing `resume_members=true` will resume the existing billing period for eligible group members. The primary subscription will begin a new billing period. /// For calendar billing subscriptions, the new billing period created will be a partial one, spanning from the date of reactivation to the next corresponding calendar renewal date. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -135,16 +140,19 @@ public Models.ReactivateSubscriptionGroupResponse ReactivateSubscriptionGroup( => CoreHelper.RunTask(ReactivateSubscriptionGroupAsync(uid, body)); /// - /// This endpoint will attempt to reactivate or resume a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. + /// Reactivates or resumes a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. /// Whether a subscription group is reactivated (a new billing period is created) or resumed (the current billing period is respected) will depend on the parameters that are sent with the request as well as the date of the request relative to the primary subscription's period. /// ## Reactivating within the current period. - /// If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period the `resume=true` option must be passed in request parameters. - /// An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed the request will return an error. + /// If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period, the `resume=true` option must be passed in request parameters. + /// An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed, the request will return an error. /// The `resume_members` option is ignored in this case. All eligible group members will be automatically resumed. /// ## Reactivating beyond the current period. /// In this case, a subscription group can only be reactivated with a new billing period. If the `resume=true` option is passed it will be ignored. /// Member subscriptions can have billing periods that are longer than the primary (e.g. a monthly primary with annual group members). If the primary subscription in a group cannot be reactivated within the current period, but other group members can be, passing `resume_members=true` will resume the existing billing period for eligible group members. The primary subscription will begin a new billing period. /// For calendar billing subscriptions, the new billing period created will be a partial one, spanning from the date of reactivation to the next corresponding calendar renewal date. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionGroupsController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionGroupsController.cs index 1d64039c..128b44d0 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionGroupsController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionGroupsController.cs @@ -27,13 +27,13 @@ public class SubscriptionGroupsController : BaseController internal SubscriptionGroupsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Create multiple subscriptions at once under the same customer and consolidate them into a subscription group. + /// Creates multiple subscriptions at once under the same customer and consolidates them into a subscription group. /// You must provide one and only one of the `payer_id`/`payer_reference`/`payer_attributes` for the customer attached to the group. /// You must provide one and only one of the `payment_profile_id`/`credit_card_attributes`/`bank_account_attributes` for the payment profile attached to the group. /// Only one of the `subscriptions` can have `"primary": true` attribute set. - /// When passing product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. + /// When passing a product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. /// The subscription request examples below will be split into two sections. - /// The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Chargify.js. + /// The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Maxio.js (formerly Chargify.js). /// /// Optional parameter: . /// Returns the Models.SubscriptionGroupSignupResponse response from the API call. @@ -42,13 +42,13 @@ public Models.SubscriptionGroupSignupResponse SignupWithSubscriptionGroup( => CoreHelper.RunTask(SignupWithSubscriptionGroupAsync(body)); /// - /// Create multiple subscriptions at once under the same customer and consolidate them into a subscription group. + /// Creates multiple subscriptions at once under the same customer and consolidates them into a subscription group. /// You must provide one and only one of the `payer_id`/`payer_reference`/`payer_attributes` for the customer attached to the group. /// You must provide one and only one of the `payment_profile_id`/`credit_card_attributes`/`bank_account_attributes` for the payment profile attached to the group. /// Only one of the `subscriptions` can have `"primary": true` attribute set. - /// When passing product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. + /// When passing a product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. /// The subscription request examples below will be split into two sections. - /// The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Chargify.js. + /// The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Maxio.js (formerly Chargify.js). /// /// Optional parameter: . /// cancellationToken. @@ -129,7 +129,7 @@ public Models.ListSubscriptionGroupsResponse ListSubscriptionGroups( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to find subscription group details. + /// Returns subscription group details. /// #### Current Billing Amount in Cents. /// Current billing amount for the subscription group is not returned by default. If this information is desired, the `include[]=current_billing_amount_in_cents` parameter must be provided with the request. /// @@ -142,7 +142,7 @@ public Models.FullSubscriptionGroupResponse ReadSubscriptionGroup( => CoreHelper.RunTask(ReadSubscriptionGroupAsync(uid, include)); /// - /// Use this endpoint to find subscription group details. + /// Returns subscription group details. /// #### Current Billing Amount in Cents. /// Current billing amount for the subscription group is not returned by default. If this information is desired, the `include[]=current_billing_amount_in_cents` parameter must be provided with the request. /// @@ -164,8 +164,8 @@ public Models.FullSubscriptionGroupResponse ReadSubscriptionGroup( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to update subscription group members. - /// `"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from subscription group. To clean up members, just leave the array empty. + /// Updates subscription group members. + /// `"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from the subscription group. To clean up members, just leave the array empty. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -176,8 +176,8 @@ public Models.SubscriptionGroupResponse UpdateSubscriptionGroupMembers( => CoreHelper.RunTask(UpdateSubscriptionGroupMembersAsync(uid, body)); /// - /// Use this endpoint to update subscription group members. - /// `"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from subscription group. To clean up members, just leave the array empty. + /// Updates subscription group members. + /// `"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from the subscription group. To clean up members, just leave the array empty. /// /// Required parameter: The uid of the subscription group. /// Optional parameter: . @@ -230,8 +230,8 @@ public Models.DeleteSubscriptionGroupResponse DeleteSubscriptionGroup( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to find subscription group associated with subscription. - /// If the subscription is not in a group endpoint will return 404 code. + /// Finds the subscription group associated with a subscription. + /// If the subscription is not in a group, the endpoint will return a 404 code. /// /// Required parameter: The Advanced Billing id of the subscription associated with the subscription group. /// Returns the Models.FullSubscriptionGroupResponse response from the API call. @@ -240,8 +240,8 @@ public Models.FullSubscriptionGroupResponse FindSubscriptionGroup( => CoreHelper.RunTask(FindSubscriptionGroupAsync(subscriptionId)); /// - /// Use this endpoint to find subscription group associated with subscription. - /// If the subscription is not in a group endpoint will return 404 code. + /// Finds the subscription group associated with a subscription. + /// If the subscription is not in a group, the endpoint will return a 404 code. /// /// Required parameter: The Advanced Billing id of the subscription associated with the subscription group. /// cancellationToken. @@ -308,7 +308,7 @@ public Models.SubscriptionGroupResponse AddSubscriptionToGroup( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove existing subscription from subscription group. + /// For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove an existing subscription from a subscription group. /// /// Required parameter: The Chargify id of the subscription.. public void RemoveSubscriptionFromGroup( @@ -316,7 +316,7 @@ public void RemoveSubscriptionFromGroup( => CoreHelper.RunVoidTask(RemoveSubscriptionFromGroupAsync(subscriptionId)); /// - /// For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove existing subscription from subscription group. + /// For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove an existing subscription from a subscription group. /// /// Required parameter: The Chargify id of the subscription.. /// cancellationToken. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionInvoiceAccountController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionInvoiceAccountController.cs index 09e42d60..ad0e93c2 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionInvoiceAccountController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionInvoiceAccountController.cs @@ -50,10 +50,13 @@ public Models.AccountBalances ReadAccountBalances( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// ## Create Prepayment. + /// Creates a prepayment for a subscription. /// In order to specify a prepayment made against a subscription, specify the `amount, memo, details, method`. /// When the `method` specified is `"credit_card_on_file"`, the prepayment amount will be collected using the default credit card payment profile and applied to the prepayment account balance. This is especially useful for manual replenishment of prepaid subscriptions. /// Note that passing `amount_in_cents` is now allowed. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -64,10 +67,13 @@ public Models.CreatePrepaymentResponse CreatePrepayment( => CoreHelper.RunTask(CreatePrepaymentAsync(subscriptionId, body)); /// - /// ## Create Prepayment. + /// Creates a prepayment for a subscription. /// In order to specify a prepayment made against a subscription, specify the `amount, memo, details, method`. /// When the `method` specified is `"credit_card_on_file"`, the prepayment amount will be collected using the default credit card payment profile and applied to the prepayment account balance. This is especially useful for manual replenishment of prepaid subscriptions. /// Note that passing `amount_in_cents` is now allowed. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -90,7 +96,7 @@ public Models.CreatePrepaymentResponse CreatePrepayment( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will list a subscription's prepayments. + /// Lists a subscription's prepayments. /// /// Object containing request parameters. /// Returns the Models.PrepaymentsResponse response from the API call. @@ -99,7 +105,7 @@ public Models.PrepaymentsResponse ListPrepayments( => CoreHelper.RunTask(ListPrepaymentsAsync(input)); /// - /// This request will list a subscription's prepayments. + /// Lists a subscription's prepayments. /// /// Object containing request parameters. /// cancellationToken. @@ -121,7 +127,7 @@ public Models.PrepaymentsResponse ListPrepayments( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Credit will be added to the subscription in the amount specified in the request body. The credit is subsequently applied to the next generated invoice. + /// Adds a service credit to the subscription in the specified amount. The credit is subsequently applied to the next generated invoice. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -132,7 +138,7 @@ public Models.ServiceCredit IssueServiceCredit( => CoreHelper.RunTask(IssueServiceCreditAsync(subscriptionId, body)); /// - /// Credit will be added to the subscription in the amount specified in the request body. The credit is subsequently applied to the next generated invoice. + /// Adds a service credit to the subscription in the specified amount. The credit is subsequently applied to the next generated invoice. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -155,7 +161,7 @@ public Models.ServiceCredit IssueServiceCredit( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Credit will be removed from the subscription in the amount specified in the request body. The credit amount being deducted must be equal to or less than the current credit balance. + /// Deducts a service credit from the subscription in the specified amount. The credit amount being deducted must be equal to or less than the current credit balance. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -165,7 +171,7 @@ public void DeductServiceCredit( => CoreHelper.RunVoidTask(DeductServiceCreditAsync(subscriptionId, body)); /// - /// Credit will be removed from the subscription in the amount specified in the request body. The credit amount being deducted must be equal to or less than the current credit balance. + /// Deducts a service credit from the subscription in the specified amount. The credit amount being deducted must be equal to or less than the current credit balance. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -188,7 +194,7 @@ public async Task DeductServiceCreditAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This request will list a subscription's service credits. + /// Lists a subscription's service credits. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`.. @@ -203,7 +209,7 @@ public Models.ListServiceCreditsResponse ListServiceCredits( => CoreHelper.RunTask(ListServiceCreditsAsync(subscriptionId, page, perPage, direction)); /// - /// This request will list a subscription's service credits. + /// Lists a subscription's service credits. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query `page=1`.. @@ -232,7 +238,7 @@ public Models.ListServiceCreditsResponse ListServiceCredits( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This endpoint will refund, completely or partially, a particular prepayment applied to a subscription. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. + /// Refunds a prepayment applied to a subscription, either fully or partially. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. /// The amount may be passed either as a decimal, with `amount`, or an integer in cents, with `amount_in_cents`. /// /// Required parameter: The Chargify id of the subscription.. @@ -246,7 +252,7 @@ public Models.PrepaymentResponse RefundPrepayment( => CoreHelper.RunTask(RefundPrepaymentAsync(subscriptionId, prepaymentId, body)); /// - /// This endpoint will refund, completely or partially, a particular prepayment applied to a subscription. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. + /// Refunds a prepayment applied to a subscription, either fully or partially. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. /// The amount may be passed either as a decimal, with `amount`, or an integer in cents, with `amount_in_cents`. /// /// Required parameter: The Chargify id of the subscription.. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionNotesController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionNotesController.cs index 63ad3b5f..68de2303 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionNotesController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionNotesController.cs @@ -25,7 +25,7 @@ public class SubscriptionNotesController : BaseController internal SubscriptionNotesController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Use the following method to create a note for a subscription. + /// Creates a note for a subscription. /// ## How to Use Subscription Notes. /// Notes allow you to record information about a particular Subscription in a free text format. /// If you have structured data such as birth date, color, etc., consider using Metadata instead. @@ -40,7 +40,7 @@ public Models.SubscriptionNoteResponse CreateSubscriptionNote( => CoreHelper.RunTask(CreateSubscriptionNoteAsync(subscriptionId, body)); /// - /// Use the following method to create a note for a subscription. + /// Creates a note for a subscription. /// ## How to Use Subscription Notes. /// Notes allow you to record information about a particular Subscription in a free text format. /// If you have structured data such as birth date, color, etc., consider using Metadata instead. @@ -67,7 +67,7 @@ public Models.SubscriptionNoteResponse CreateSubscriptionNote( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this method to retrieve a list of Notes associated with a Subscription. The response will be an array of Notes. + /// Retrieves a list of notes associated with a subscription. The response will be an array of Notes. /// /// Object containing request parameters. /// Returns the List of Models.SubscriptionNoteResponse response from the API call. @@ -76,7 +76,7 @@ public Models.SubscriptionNoteResponse CreateSubscriptionNote( => CoreHelper.RunTask(ListSubscriptionNotesAsync(input)); /// - /// Use this method to retrieve a list of Notes associated with a Subscription. The response will be an array of Notes. + /// Retrieves a list of notes associated with a subscription. The response will be an array of Notes. /// /// Object containing request parameters. /// cancellationToken. @@ -97,7 +97,7 @@ public Models.SubscriptionNoteResponse CreateSubscriptionNote( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Once you have obtained the ID of the note you wish to read, use this method to show a particular note attached to a subscription. + /// Retrieves a specific note attached to a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the note. @@ -108,7 +108,7 @@ public Models.SubscriptionNoteResponse ReadSubscriptionNote( => CoreHelper.RunTask(ReadSubscriptionNoteAsync(subscriptionId, noteId)); /// - /// Once you have obtained the ID of the note you wish to read, use this method to show a particular note attached to a subscription. + /// Retrieves a specific note attached to a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the note. @@ -128,7 +128,7 @@ public Models.SubscriptionNoteResponse ReadSubscriptionNote( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use the following method to update a note for a Subscription. + /// Updates a note for a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the note. @@ -141,7 +141,7 @@ public Models.SubscriptionNoteResponse UpdateSubscriptionNote( => CoreHelper.RunTask(UpdateSubscriptionNoteAsync(subscriptionId, noteId, body)); /// - /// Use the following method to update a note for a Subscription. + /// Updates a note for a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Required parameter: The Advanced Billing id of the note. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionProductsController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionProductsController.cs index 2462a666..1dfa6476 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionProductsController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionProductsController.cs @@ -23,7 +23,7 @@ public class SubscriptionProductsController : BaseController internal SubscriptionProductsController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// + /// Important note: One of the most common ways that a migration can fail is when the attempt is made to migrate a subscription to its current product. . + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -73,7 +45,7 @@ public Models.SubscriptionResponse MigrateSubscriptionProduct( => CoreHelper.RunTask(MigrateSubscriptionProductAsync(subscriptionId, body)); /// - /// + /// Important note: One of the most common ways that a migration can fail is when the attempt is made to migrate a subscription to its current product. . + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -135,8 +79,9 @@ public Models.SubscriptionResponse MigrateSubscriptionProduct( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// + /// Previews the charges resulting from migrating a subscription to a different product. /// ## Previewing a future date. - /// It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (eg: `"proration_date": "2020-12-18T18:25:43.511Z"`). + /// It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (e.g., `"proration_date": "2020-12-18T18:25:43.511Z"`). /// This will calculate the prorated adjustment, charge, payment and credit applied values assuming the migration is done at that date in the future as opposed to right now. /// /// Required parameter: The Chargify id of the subscription.. @@ -148,8 +93,9 @@ public Models.SubscriptionMigrationPreviewResponse PreviewSubscriptionProductMig => CoreHelper.RunTask(PreviewSubscriptionProductMigrationAsync(subscriptionId, body)); /// + /// Previews the charges resulting from migrating a subscription to a different product. /// ## Previewing a future date. - /// It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (eg: `"proration_date": "2020-12-18T18:25:43.511Z"`). + /// It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (e.g., `"proration_date": "2020-12-18T18:25:43.511Z"`). /// This will calculate the prorated adjustment, charge, payment and credit applied values assuming the migration is done at that date in the future as opposed to right now. /// /// Required parameter: The Chargify id of the subscription.. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionStatusController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionStatusController.cs index 2ab37306..36defcbd 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionStatusController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionStatusController.cs @@ -23,11 +23,10 @@ public class SubscriptionStatusController : BaseController internal SubscriptionStatusController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Advanced Billing offers the ability to retry collecting the balance due on a past due Subscription without waiting for the next scheduled attempt. - /// ## Successful Reactivation. - /// The response will be `200 OK` with the updated Subscription. - /// ## Failed Reactivation. - /// The response will be `422 "Unprocessable Entity`. + /// Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Returns the Models.SubscriptionResponse response from the API call. @@ -36,11 +35,10 @@ public Models.SubscriptionResponse RetrySubscription( => CoreHelper.RunTask(RetrySubscriptionAsync(subscriptionId)); /// - /// Advanced Billing offers the ability to retry collecting the balance due on a past due Subscription without waiting for the next scheduled attempt. - /// ## Successful Reactivation. - /// The response will be `200 OK` with the updated Subscription. - /// ## Failed Reactivation. - /// The response will be `422 "Unprocessable Entity`. + /// Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// cancellationToken. @@ -96,7 +94,7 @@ public Models.SubscriptionResponse CancelSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// 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. + /// Resumes 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. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: (For calendar billing subscriptions only) The way that the resumed subscription's charge should be handled.. @@ -107,7 +105,7 @@ public Models.SubscriptionResponse ResumeSubscription( => CoreHelper.RunTask(ResumeSubscriptionAsync(subscriptionId, calendarBillingResumptionCharge)); /// - /// 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. + /// Resumes 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. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: (For calendar billing subscriptions only) The way that the resumed subscription's charge should be handled.. @@ -129,7 +127,7 @@ public Models.SubscriptionResponse ResumeSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This will place the subscription in the on_hold state and it will not renew. + /// Places the subscription on hold, preventing it from renewing. /// ## Limitations. /// You may not place a subscription on hold if the `next_billing_at` date is within 24 hours. /// @@ -142,7 +140,7 @@ public Models.SubscriptionResponse PauseSubscription( => CoreHelper.RunTask(PauseSubscriptionAsync(subscriptionId, body)); /// - /// This will place the subscription in the on_hold state and it will not renew. + /// Places the subscription on hold, preventing it from renewing. /// ## Limitations. /// You may not place a subscription on hold if the `next_billing_at` date is within 24 hours. /// @@ -167,10 +165,10 @@ public Models.SubscriptionResponse PauseSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Once a subscription has been paused / put on hold, you can update the date which was specified to automatically resume the subscription. + /// Updates the date on which a paused subscription will automatically resume. /// To update a subscription's resume date, use this method to change or update the `automatically_resume_at` date. /// ### Remove the resume date. - /// Alternately, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. + /// Alternatively, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -181,10 +179,10 @@ public Models.SubscriptionResponse UpdateAutomaticSubscriptionResumption( => CoreHelper.RunTask(UpdateAutomaticSubscriptionResumptionAsync(subscriptionId, body)); /// - /// Once a subscription has been paused / put on hold, you can update the date which was specified to automatically resume the subscription. + /// Updates the date on which a paused subscription will automatically resume. /// To update a subscription's resume date, use this method to change or update the `automatically_resume_at` date. /// ### Remove the resume date. - /// Alternately, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. + /// Alternatively, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -207,7 +205,7 @@ public Models.SubscriptionResponse UpdateAutomaticSubscriptionResumption( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). + /// Reactivates a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). /// **Note: The term "resume" is used also during another process in Advanced Billing. 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 `canceled_at` and `cancellation_message` fields do not have values. @@ -219,7 +217,7 @@ public Models.SubscriptionResponse UpdateAutomaticSubscriptionResumption( /// 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 Advanced Billing 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 Advanced Billing would not resume the subscription, and instead it would be reactivated with a new billing period. - /// If a reactivation with `resume: false`, or where 'resume" is omited were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period were possible. + /// If a reactivation with `resume: false`, or where 'resume' is omitted were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period was possible. /// | Canceled | Reactivation | Resumable? |. /// |---|---|---|. /// | Jun 15 | June 28 | Yes |. @@ -305,6 +303,9 @@ public Models.SubscriptionResponse UpdateAutomaticSubscriptionResumption( /// + The subscription will transition to active. /// + The next billing date should not have changed. /// + Any product-related charges should have been collected. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -315,7 +316,7 @@ public Models.SubscriptionResponse ReactivateSubscription( => CoreHelper.RunTask(ReactivateSubscriptionAsync(subscriptionId, body)); /// - /// Reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). + /// Reactivates a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). /// **Note: The term "resume" is used also during another process in Advanced Billing. 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 `canceled_at` and `cancellation_message` fields do not have values. @@ -327,7 +328,7 @@ public Models.SubscriptionResponse ReactivateSubscription( /// 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 Advanced Billing 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 Advanced Billing would not resume the subscription, and instead it would be reactivated with a new billing period. - /// If a reactivation with `resume: false`, or where 'resume" is omited were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period were possible. + /// If a reactivation with `resume: false`, or where 'resume' is omitted were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period was possible. /// | Canceled | Reactivation | Resumable? |. /// |---|---|---|. /// | Jun 15 | June 28 | Yes |. @@ -413,6 +414,9 @@ public Models.SubscriptionResponse ReactivateSubscription( /// + The subscription will transition to active. /// + The next billing date should not have changed. /// + Any product-related charges should have been collected. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -470,7 +474,7 @@ public Models.DelayedCancellationResponse InitiateDelayedCancellation( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Removing the delayed cancellation on a subscription will ensure that it doesn't get canceled at the end of the period that it is in. The request will reset the `cancel_at_end_of_period` flag to `false`. + /// Removes the delayed cancellation from a subscription, ensuring it is not canceled at the end of the current period. The request will reset the `cancel_at_end_of_period` flag to `false`. /// This endpoint is idempotent. If the subscription was not set to cancel in the future, removing the delayed cancellation has no effect and the call will be successful. /// /// Required parameter: The Chargify id of the subscription.. @@ -480,7 +484,7 @@ public Models.DelayedCancellationResponse CancelDelayedCancellation( => CoreHelper.RunTask(CancelDelayedCancellationAsync(subscriptionId)); /// - /// Removing the delayed cancellation on a subscription will ensure that it doesn't get canceled at the end of the period that it is in. The request will reset the `cancel_at_end_of_period` flag to `false`. + /// Removes the delayed cancellation from a subscription, ensuring it is not canceled at the end of the current period. The request will reset the `cancel_at_end_of_period` flag to `false`. /// This endpoint is idempotent. If the subscription was not set to cancel in the future, removing the delayed cancellation has no effect and the call will be successful. /// /// Required parameter: The Chargify id of the subscription.. @@ -500,7 +504,7 @@ public Models.DelayedCancellationResponse CancelDelayedCancellation( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// If a subscription is currently in dunning, the subscription will be set to active and the active Dunner will be resolved. + /// Cancels the active dunning process for a subscription and sets it to active. /// /// Required parameter: The Chargify id of the subscription.. /// Returns the Models.SubscriptionResponse response from the API call. @@ -509,7 +513,7 @@ public Models.SubscriptionResponse CancelDunning( => CoreHelper.RunTask(CancelDunningAsync(subscriptionId)); /// - /// If a subscription is currently in dunning, the subscription will be set to active and the active Dunner will be resolved. + /// Cancels the active dunning process for a subscription and sets it to active. /// /// Required parameter: The Chargify id of the subscription.. /// cancellationToken. @@ -528,7 +532,7 @@ public Models.SubscriptionResponse CancelDunning( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// The Chargify API allows you to preview a renewal by posting to the renewals endpoint. 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. + /// Previews a subscription’s next renewal assessment. 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. /// The "Next Billing" amount and "Next Billing" date are already represented in the UI on each Subscriber's Summary. For more information, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). /// ## Optional Component Fields. /// This endpoint is particularly useful due to the fact that it will return the computed billing amount for the base product and the components which are in use by a subscriber. @@ -551,7 +555,7 @@ public Models.RenewalPreviewResponse PreviewRenewal( => CoreHelper.RunTask(PreviewRenewalAsync(subscriptionId, body)); /// - /// The Chargify API allows you to preview a renewal by posting to the renewals endpoint. 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. + /// Previews a subscription’s next renewal assessment. 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. /// The "Next Billing" amount and "Next Billing" date are already represented in the UI on each Subscriber's Summary. For more information, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). /// ## Optional Component Fields. /// This endpoint is particularly useful due to the fact that it will return the computed billing amount for the base product and the components which are in use by a subscriber. diff --git a/AdvancedBilling.Standard/Controllers/SubscriptionsController.cs b/AdvancedBilling.Standard/Controllers/SubscriptionsController.cs index 609deca2..b69d79d2 100644 --- a/AdvancedBilling.Standard/Controllers/SubscriptionsController.cs +++ b/AdvancedBilling.Standard/Controllers/SubscriptionsController.cs @@ -28,13 +28,17 @@ internal SubscriptionsController(GlobalConfiguration globalConfiguration) : base /// /// Creates a Subscription for a customer and product. - /// Specify the product with `product_id` or `product_handle`. To set a specific product pricepPoint, use `product_price_point_handle` or `product_price_point_id`. + /// Specify the product with `product_id` or `product_handle`. To set a specific product price point, use `product_price_point_handle` or `product_price_point_id`. /// Identify an existing customer with `customer_id` or `customer_reference`. Optionally, include an existing payment profile using `payment_profile_id`. To create a new customer, pass customer_attributes. . /// Select an option from the **Request Examples** drop-down on the right side of the portal to see examples of common scenarios for creating subscriptions. . - /// Payment information may be required to create a subscription, depending on the options for the Product being subscribed. See [product options](https://docs.maxio.com/hc/en-us/articles/24261076617869-Edit-Products) for more information. See the [Payments Profile]($e/Payment%20Profiles/createPaymentProfile) endpoint for details on payment parameters. - /// Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. - /// Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. /// See the [Subscription Signups](page:introduction/basic-concepts/subscription-signup) article for more information on working with subscriptions in Advanced Billing. + /// ## Payment information . + /// Payment information may be required to create a subscription, depending on the options for the Product being subscribed. See [product options](https://docs.maxio.com/hc/en-us/articles/24261076617869-Edit-Products) for more information. See the [Payments Profile]($e/Payment%20Profiles/createPaymentProfile) endpoint for details on payment parameters. . + /// Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. + /// Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Maxio.js (formerly Chargify.js)](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Optional parameter: . /// Returns the Models.SubscriptionResponse response from the API call. @@ -44,13 +48,17 @@ public Models.SubscriptionResponse CreateSubscription( /// /// Creates a Subscription for a customer and product. - /// Specify the product with `product_id` or `product_handle`. To set a specific product pricepPoint, use `product_price_point_handle` or `product_price_point_id`. + /// Specify the product with `product_id` or `product_handle`. To set a specific product price point, use `product_price_point_handle` or `product_price_point_id`. /// Identify an existing customer with `customer_id` or `customer_reference`. Optionally, include an existing payment profile using `payment_profile_id`. To create a new customer, pass customer_attributes. . /// Select an option from the **Request Examples** drop-down on the right side of the portal to see examples of common scenarios for creating subscriptions. . - /// Payment information may be required to create a subscription, depending on the options for the Product being subscribed. See [product options](https://docs.maxio.com/hc/en-us/articles/24261076617869-Edit-Products) for more information. See the [Payments Profile]($e/Payment%20Profiles/createPaymentProfile) endpoint for details on payment parameters. - /// Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. - /// Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. /// See the [Subscription Signups](page:introduction/basic-concepts/subscription-signup) article for more information on working with subscriptions in Advanced Billing. + /// ## Payment information . + /// Payment information may be required to create a subscription, depending on the options for the Product being subscribed. See [product options](https://docs.maxio.com/hc/en-us/articles/24261076617869-Edit-Products) for more information. See the [Payments Profile]($e/Payment%20Profiles/createPaymentProfile) endpoint for details on payment parameters. . + /// Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. + /// Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Maxio.js (formerly Chargify.js)](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. + /// ## 3D Secure (3DS) Authentication post-authentication flow. + /// When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. . + /// See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. /// /// Optional parameter: . /// cancellationToken. @@ -70,7 +78,7 @@ public Models.SubscriptionResponse CreateSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. + /// Returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. /// ## Search for a subscription. /// Use the query strings below to search for a subscription using the criteria available. The return value will be an array. /// ## Self-Service Page token. @@ -83,7 +91,7 @@ public Models.SubscriptionResponse CreateSubscription( => CoreHelper.RunTask(ListSubscriptionsAsync(input)); /// - /// returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. + /// Returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. /// ## Search for a subscription. /// Use the query strings below to search for a subscription using the criteria available. The return value will be an array. /// ## Self-Service Page token. @@ -136,14 +144,14 @@ public Models.SubscriptionResponse CreateSubscription( /// You can also perform a delayed change to the price point by passing in either `product_price_point_id` or `product_price_point_handle`. /// > **Note:** To cancel a delayed product change, set `next_product_id` to an empty string. /// ## Billing Date Changes. - /// You can update dates for a subscrption. . + /// You can update dates for a subscription. /// ### Regular Billing Date Changes. /// Send the `next_billing_at` to set the next billing date for the subscription. After that date passes and the subscription is processed, the following billing date will be set according to the subscription's product period. - /// > Note: If you pass an invalid date, the correct date is automatically set to he correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. + /// > Note: If you pass an invalid date, the correct date is automatically set to the correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. /// The server response will not return data under the key/value pair of `next_billing_at`. View the key/value pair of `current_period_ends_at` to verify that the `next_billing_at` date has been changed successfully. - /// ### Calendar Billing and Snap Day Changes. + /// ### Calendar Billing and Snap Day Changes. /// For a subscription using Calendar Billing, setting the next billing date is a bit different. Send the `snap_day` attribute to change the calendar billing date for **a subscription using a product eligible for calendar billing**. - /// > Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day`will will reset to 'null on the next billing cycle. This is because a product change is instantanous and only affects the product associated with a subscription. + /// > Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day` will reset to null on the next billing cycle. This is because a product change is instantaneous and only affects the product associated with a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -171,14 +179,14 @@ public Models.SubscriptionResponse UpdateSubscription( /// You can also perform a delayed change to the price point by passing in either `product_price_point_id` or `product_price_point_handle`. /// > **Note:** To cancel a delayed product change, set `next_product_id` to an empty string. /// ## Billing Date Changes. - /// You can update dates for a subscrption. . + /// You can update dates for a subscription. /// ### Regular Billing Date Changes. /// Send the `next_billing_at` to set the next billing date for the subscription. After that date passes and the subscription is processed, the following billing date will be set according to the subscription's product period. - /// > Note: If you pass an invalid date, the correct date is automatically set to he correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. + /// > Note: If you pass an invalid date, the correct date is automatically set to the correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. /// The server response will not return data under the key/value pair of `next_billing_at`. View the key/value pair of `current_period_ends_at` to verify that the `next_billing_at` date has been changed successfully. - /// ### Calendar Billing and Snap Day Changes. + /// ### Calendar Billing and Snap Day Changes. /// For a subscription using Calendar Billing, setting the next billing date is a bit different. Send the `snap_day` attribute to change the calendar billing date for **a subscription using a product eligible for calendar billing**. - /// > Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day`will will reset to 'null on the next billing cycle. This is because a product change is instantanous and only affects the product associated with a subscription. + /// > Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day` will reset to null on the next billing cycle. This is because a product change is instantaneous and only affects the product associated with a subscription. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -236,7 +244,7 @@ public Models.SubscriptionResponse ReadSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// This API endpoint allows you to set certain subscription fields that are usually managed for you automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. + /// Sets certain subscription fields that are usually managed automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. /// This endpoint is provided for cases where you need to “align” Advanced Billing data with data that happened in your system, perhaps before you started using Advanced Billing. For example, you may choose to import your historical subscription data, and would like the activation and cancellation dates in Advanced Billing to match your existing historical dates. Advanced Billing does not backfill historical events (i.e. from the Events API), but some static data can be changed via this API. /// Why are some fields only settable from this endpoint, and not the normal subscription create and update endpoints? Because we want users of this endpoint to be aware that these fields are usually managed by Advanced Billing, and using this API means **you are stepping out on your own.**. /// Changing these fields will not affect any other attributes. For example, adding an expiration date will not affect the next assessment date on the subscription. @@ -256,7 +264,7 @@ public void OverrideSubscription( => CoreHelper.RunVoidTask(OverrideSubscriptionAsync(subscriptionId, body)); /// - /// This API endpoint allows you to set certain subscription fields that are usually managed for you automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. + /// Sets certain subscription fields that are usually managed automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. /// This endpoint is provided for cases where you need to “align” Advanced Billing data with data that happened in your system, perhaps before you started using Advanced Billing. For example, you may choose to import your historical subscription data, and would like the activation and cancellation dates in Advanced Billing to match your existing historical dates. Advanced Billing does not backfill historical events (i.e. from the Events API), but some static data can be changed via this API. /// Why are some fields only settable from this endpoint, and not the normal subscription create and update endpoints? Because we want users of this endpoint to be aware that these fields are usually managed by Advanced Billing, and using this API means **you are stepping out on your own.**. /// Changing these fields will not affect any other attributes. For example, adding an expiration date will not affect the next assessment date on the subscription. @@ -289,7 +297,7 @@ public async Task OverrideSubscriptionAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to find a subscription by its reference. + /// Finds a subscription by its reference. /// /// Optional parameter: Subscription reference. /// Returns the Models.SubscriptionResponse response from the API call. @@ -298,7 +306,7 @@ public Models.SubscriptionResponse FindSubscription( => CoreHelper.RunTask(FindSubscriptionAsync(reference)); /// - /// Use this endpoint to find a subscription by its reference. + /// Finds a subscription by its reference. /// /// Optional parameter: Subscription reference. /// cancellationToken. @@ -318,7 +326,7 @@ public Models.SubscriptionResponse FindSubscription( /// /// /// - /// Use this endpoint to update a subscription's prepaid configuration. + /// Updates a subscription's prepaid configuration. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -378,7 +386,7 @@ public Models.PrepaidConfigurationResponse UpdatePrepaidSubscriptionConfiguratio => CoreHelper.RunTask(UpdatePrepaidSubscriptionConfigurationAsync(subscriptionId, body)); /// - /// Use this endpoint to update a subscription's prepaid configuration. + /// Updates a subscription's prepaid configuration. /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: . @@ -401,7 +409,7 @@ public Models.PrepaidConfigurationResponse UpdatePrepaidSubscriptionConfiguratio .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// The Chargify API allows you to preview a subscription by POSTing the same JSON or XML as for a subscription creation. + /// Previews a subscription by POSTing the same JSON or XML as for a subscription creation. /// The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. /// A subscription will not be created by utilizing this endpoint; it is meant to serve as a prediction. /// For more information, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). @@ -423,7 +431,7 @@ public Models.SubscriptionPreviewResponse PreviewSubscription( => CoreHelper.RunTask(PreviewSubscriptionAsync(body)); /// - /// The Chargify API allows you to preview a subscription by POSTing the same JSON or XML as for a subscription creation. + /// Previews a subscription by POSTing the same JSON or XML as for a subscription creation. /// The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. /// A subscription will not be created by utilizing this endpoint; it is meant to serve as a prediction. /// For more information, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). @@ -454,6 +462,7 @@ public Models.SubscriptionPreviewResponse PreviewSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// + /// Applies one or more coupon codes to an existing subscription. /// An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if each coupon is stackable. For more information on stackable coupons, we recommend reviewing our [coupon documentation.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#stackability-rules). /// ## Query Parameters vs Request Body Parameters. /// Passing in a coupon code as a query parameter will add the code to the subscription, completely replacing all existing coupon codes on the subscription. @@ -470,6 +479,7 @@ public Models.SubscriptionResponse ApplyCouponsToSubscription( => CoreHelper.RunTask(ApplyCouponsToSubscriptionAsync(subscriptionId, code, body)); /// + /// Applies one or more coupon codes to an existing subscription. /// An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if each coupon is stackable. For more information on stackable coupons, we recommend reviewing our [coupon documentation.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#stackability-rules). /// ## Query Parameters vs Request Body Parameters. /// Passing in a coupon code as a query parameter will add the code to the subscription, completely replacing all existing coupon codes on the subscription. @@ -499,8 +509,8 @@ public Models.SubscriptionResponse ApplyCouponsToSubscription( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Use this endpoint to remove a coupon from an existing subscription. - /// For more information on the expected behaviour of removing a coupon from a subscription, See our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon). + /// Removes a coupon from an existing subscription. + /// For more information on the expected behavior of removing a coupon from a subscription, see our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon). /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: The coupon code. @@ -511,8 +521,8 @@ public string RemoveCouponFromSubscription( => CoreHelper.RunTask(RemoveCouponFromSubscriptionAsync(subscriptionId, couponCode)); /// - /// Use this endpoint to remove a coupon from an existing subscription. - /// For more information on the expected behaviour of removing a coupon from a subscription, See our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon). + /// Removes a coupon from an existing subscription. + /// For more information on the expected behavior of removing a coupon from a subscription, see our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon). /// /// Required parameter: The Chargify id of the subscription.. /// Optional parameter: The coupon code. @@ -534,7 +544,7 @@ public async Task RemoveCouponFromSubscriptionAsync( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Advanced Billing offers the ability to activate awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. + /// Activates awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. /// For details on how the activation works, and how to activate subscriptions through the application, see [activation](#). /// The `revert_on_failure` parameter controls the behavior upon activation failure. /// - If set to `true` and something goes wrong i.e. payment fails, then Advanced Billing will not change the subscription's state. The subscription’s billing period will also remain the same. @@ -575,7 +585,7 @@ public Models.SubscriptionResponse ActivateSubscription( => CoreHelper.RunTask(ActivateSubscriptionAsync(subscriptionId, body)); /// - /// Advanced Billing offers the ability to activate awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. + /// Activates awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. /// For details on how the activation works, and how to activate subscriptions through the application, see [activation](#). /// The `revert_on_failure` parameter controls the behavior upon activation failure. /// - If set to `true` and something goes wrong i.e. payment fails, then Advanced Billing will not change the subscription's state. The subscription’s billing period will also remain the same. diff --git a/AdvancedBilling.Standard/Controllers/WebhooksController.cs b/AdvancedBilling.Standard/Controllers/WebhooksController.cs index 0e117b57..9d149b09 100644 --- a/AdvancedBilling.Standard/Controllers/WebhooksController.cs +++ b/AdvancedBilling.Standard/Controllers/WebhooksController.cs @@ -24,7 +24,7 @@ public class WebhooksController : BaseController internal WebhooksController(GlobalConfiguration globalConfiguration) : base(globalConfiguration) { } /// - /// Allows you to view a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. + /// Retrieves a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. /// /// Object containing request parameters. /// Returns the List of Models.WebhookResponse response from the API call. @@ -33,7 +33,7 @@ internal WebhooksController(GlobalConfiguration globalConfiguration) : base(glob => CoreHelper.RunTask(ListWebhooksAsync(input)); /// - /// Allows you to view a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. + /// Retrieves a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. /// /// Object containing request parameters. /// cancellationToken. @@ -56,7 +56,7 @@ internal WebhooksController(GlobalConfiguration globalConfiguration) : base(glob .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Allows you to enable webhooks for your site. + /// Enables webhooks for your site. /// /// Optional parameter: . /// Returns the Models.EnableWebhooksResponse response from the API call. @@ -65,7 +65,7 @@ public Models.EnableWebhooksResponse EnableWebhooks( => CoreHelper.RunTask(EnableWebhooksAsync(body)); /// - /// Allows you to enable webhooks for your site. + /// Enables webhooks for your site. /// /// Optional parameter: . /// cancellationToken. @@ -110,7 +110,7 @@ public Models.ReplayWebhooksResponse ReplayWebhooks( .ExecuteAsync(cancellationToken).ConfigureAwait(false); /// - /// Creates an endpoint and assigns a list of webhooks subscriptions (events) to it. + /// Creates an endpoint and assigns a list of webhook subscriptions (events) to it. /// See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for available events. /// /// Optional parameter: . @@ -120,7 +120,7 @@ public Models.EndpointResponse CreateEndpoint( => CoreHelper.RunTask(CreateEndpointAsync(body)); /// - /// Creates an endpoint and assigns a list of webhooks subscriptions (events) to it. + /// Creates an endpoint and assigns a list of webhook subscriptions (events) to it. /// See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for available events. /// /// Optional parameter: . @@ -162,7 +162,7 @@ public Models.EndpointResponse CreateEndpoint( /// /// Updates an Endpoint. You can change the `url` of your endpoint or the list of `webhook_subscriptions` to which you are subscribed. See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for available events. /// Always send a complete list of events to which you want to subscribe. Sending a PUT request for an existing endpoint with an empty list of `webhook_subscriptions` will unsubscribe all events. - /// If you want unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. + /// If you want to unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. /// /// Required parameter: The Advanced Billing id for the endpoint that should be updated. /// Optional parameter: . @@ -175,7 +175,7 @@ public Models.EndpointResponse UpdateEndpoint( /// /// Updates an Endpoint. You can change the `url` of your endpoint or the list of `webhook_subscriptions` to which you are subscribed. See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for available events. /// Always send a complete list of events to which you want to subscribe. Sending a PUT request for an existing endpoint with an empty list of `webhook_subscriptions` will unsubscribe all events. - /// If you want unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. + /// If you want to unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. /// /// Required parameter: The Advanced Billing id for the endpoint that should be updated. /// Optional parameter: . diff --git a/AdvancedBilling.Standard/Models/ActivateEventBasedComponent.cs b/AdvancedBilling.Standard/Models/ActivateEventBasedComponent.cs index 62c937eb..0dee492d 100644 --- a/AdvancedBilling.Standard/Models/ActivateEventBasedComponent.cs +++ b/AdvancedBilling.Standard/Models/ActivateEventBasedComponent.cs @@ -43,7 +43,7 @@ public ActivateEventBasedComponent( public int? PricePointId { get; set; } /// - /// This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. + /// Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. /// [JsonProperty("billing_schedule", NullValueHandling = NullValueHandling.Ignore)] public Models.BillingSchedule BillingSchedule { get; set; } diff --git a/AdvancedBilling.Standard/Models/BankAccountPaymentProfile.cs b/AdvancedBilling.Standard/Models/BankAccountPaymentProfile.cs index 8a5af8b3..5361e754 100644 --- a/AdvancedBilling.Standard/Models/BankAccountPaymentProfile.cs +++ b/AdvancedBilling.Standard/Models/BankAccountPaymentProfile.cs @@ -23,6 +23,8 @@ public class BankAccountPaymentProfile : BaseModel private string billingCountry; private string customerVaultToken; private string billingAddress2; + private string maskedBankRoutingNumber; + private string maskedBankAccountNumber; private int? siteGatewaySettingId; private string gatewayHandle; private Dictionary shouldSerialize = new Dictionary @@ -34,6 +36,8 @@ public class BankAccountPaymentProfile : BaseModel { "billing_country", false }, { "customer_vault_token", false }, { "billing_address_2", false }, + { "masked_bank_routing_number", false }, + { "masked_bank_account_number", false }, { "site_gateway_setting_id", false }, { "gateway_handle", false }, }; @@ -48,7 +52,6 @@ public BankAccountPaymentProfile() /// /// Initializes a new instance of the class. /// - /// masked_bank_account_number. /// payment_type. /// id. /// first_name. @@ -65,6 +68,7 @@ public BankAccountPaymentProfile() /// billing_address_2. /// bank_name. /// masked_bank_routing_number. + /// masked_bank_account_number. /// bank_account_type. /// bank_account_holder_type. /// verified. @@ -73,7 +77,6 @@ public BankAccountPaymentProfile() /// created_at. /// updated_at. public BankAccountPaymentProfile( - string maskedBankAccountNumber, Models.PaymentType paymentType, int? id = null, string firstName = null, @@ -90,6 +93,7 @@ public BankAccountPaymentProfile( string billingAddress2 = null, string bankName = null, string maskedBankRoutingNumber = null, + string maskedBankAccountNumber = null, Models.BankAccountType? bankAccountType = null, Models.BankAccountHolderType? bankAccountHolderType = null, bool? verified = false, @@ -140,8 +144,16 @@ public BankAccountPaymentProfile( this.BillingAddress2 = billingAddress2; } this.BankName = bankName; - this.MaskedBankRoutingNumber = maskedBankRoutingNumber; - this.MaskedBankAccountNumber = maskedBankAccountNumber; + + if (maskedBankRoutingNumber != null) + { + this.MaskedBankRoutingNumber = maskedBankRoutingNumber; + } + + if (maskedBankAccountNumber != null) + { + this.MaskedBankAccountNumber = maskedBankAccountNumber; + } this.BankAccountType = bankAccountType; this.BankAccountHolderType = bankAccountHolderType; this.PaymentType = paymentType; @@ -193,7 +205,7 @@ public BankAccountPaymentProfile( public Models.BankAccountVault? CurrentVault { get; set; } /// - /// The “token” provided by your vault storage for an already stored payment profile + /// The "token" provided by your vault storage for an already stored payment profile /// [JsonConverter(typeof(JsonStringConverter))] [JsonProperty("vault_token", NullValueHandling = NullValueHandling.Ignore)] @@ -340,19 +352,42 @@ public string BillingAddress2 public string BankName { get; set; } /// - /// A string representation of the stored bank routing number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be bank_account + /// A string representation of the stored bank routing number with all but the last 4 digits marked with X's (i.e. 'XXXXXXX1111'). payment_type will be bank_account /// [JsonConverter(typeof(JsonStringConverter))] - [JsonProperty("masked_bank_routing_number", NullValueHandling = NullValueHandling.Ignore)] - public string MaskedBankRoutingNumber { get; set; } + [JsonProperty("masked_bank_routing_number")] + public string MaskedBankRoutingNumber + { + get + { + return this.maskedBankRoutingNumber; + } + + set + { + this.shouldSerialize["masked_bank_routing_number"] = true; + this.maskedBankRoutingNumber = value; + } + } /// - /// A string representation of the stored bank account number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’) + /// A string representation of the stored bank account number with all but the last 4 digits marked with X's (i.e. 'XXXXXXX1111') /// - [JsonConverter(typeof(JsonStringConverter), true)] + [JsonConverter(typeof(JsonStringConverter))] [JsonProperty("masked_bank_account_number")] - [JsonRequired] - public string MaskedBankAccountNumber { get; set; } + public string MaskedBankAccountNumber + { + get + { + return this.maskedBankAccountNumber; + } + + set + { + this.shouldSerialize["masked_bank_account_number"] = true; + this.maskedBankAccountNumber = value; + } + } /// /// Defaults to checking @@ -490,6 +525,20 @@ public void UnsetBillingAddress2() /// /// Marks the field to not be serialized. /// + public void UnsetMaskedBankRoutingNumber() + { + this.shouldSerialize["masked_bank_routing_number"] = false; + } + /// + /// Marks the field to not be serialized. + /// + public void UnsetMaskedBankAccountNumber() + { + this.shouldSerialize["masked_bank_account_number"] = false; + } + /// + /// Marks the field to not be serialized. + /// public void UnsetSiteGatewaySettingId() { this.shouldSerialize["site_gateway_setting_id"] = false; @@ -565,6 +614,24 @@ public bool ShouldSerializeBillingAddress2() return this.shouldSerialize["billing_address_2"]; } + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeMaskedBankRoutingNumber() + { + return this.shouldSerialize["masked_bank_routing_number"]; + } + + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeMaskedBankAccountNumber() + { + return this.shouldSerialize["masked_bank_account_number"]; + } + /// /// Checks if the field should be serialized or not. /// diff --git a/AdvancedBilling.Standard/Models/BillingSchedule.cs b/AdvancedBilling.Standard/Models/BillingSchedule.cs index 4560c8dc..5a7eeae4 100644 --- a/AdvancedBilling.Standard/Models/BillingSchedule.cs +++ b/AdvancedBilling.Standard/Models/BillingSchedule.cs @@ -15,6 +15,12 @@ namespace AdvancedBilling.Standard.Models /// public class BillingSchedule : BaseModel { + private DateTime? initialBillingAt; + private Dictionary shouldSerialize = new Dictionary + { + { "initial_billing_at", false }, + }; + /// /// Initializes a new instance of the class. /// @@ -29,15 +35,31 @@ public BillingSchedule() public BillingSchedule( DateTime? initialBillingAt = null) { - this.InitialBillingAt = initialBillingAt; + + if (initialBillingAt != null) + { + this.InitialBillingAt = initialBillingAt; + } } /// - /// The initial_billing_at attribute in Maxio allows you to specify a custom starting date for billing cycles associated with components that have their own billing frequency set. Only ISO8601 format is supported. + /// Custom start date (ISO 8601 date, YYYY-MM-DD) for the component's first billing period. If omitted or null, billing aligns with the product schedule. If provided, date must be on or after the minimum allowed date for the subscription or component. /// [JsonConverter(typeof(CustomDateTimeConverter), "yyyy'-'MM'-'dd")] - [JsonProperty("initial_billing_at", NullValueHandling = NullValueHandling.Ignore)] - public DateTime? InitialBillingAt { get; set; } + [JsonProperty("initial_billing_at")] + public DateTime? InitialBillingAt + { + get + { + return this.initialBillingAt; + } + + set + { + this.shouldSerialize["initial_billing_at"] = true; + this.initialBillingAt = value; + } + } /// public override string ToString() @@ -47,6 +69,23 @@ public override string ToString() return $"BillingSchedule : ({string.Join(", ", toStringOutput)})"; } + /// + /// Marks the field to not be serialized. + /// + public void UnsetInitialBillingAt() + { + this.shouldSerialize["initial_billing_at"] = false; + } + + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeInitialBillingAt() + { + return this.shouldSerialize["initial_billing_at"]; + } + /// public override bool Equals(object obj) { diff --git a/AdvancedBilling.Standard/Models/ChjsTokenizationFailure.cs b/AdvancedBilling.Standard/Models/ChjsTokenizationFailure.cs new file mode 100644 index 00000000..c8f05094 --- /dev/null +++ b/AdvancedBilling.Standard/Models/ChjsTokenizationFailure.cs @@ -0,0 +1,85 @@ +// +// AdvancedBilling.Standard +// +// This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). +// +using APIMatic.Core.Utilities.Converters; +using Newtonsoft.Json; +using System.Collections.Generic; + +namespace AdvancedBilling.Standard.Models +{ + /// + /// ChjsTokenizationFailure. + /// + public class ChjsTokenizationFailure : BaseModel + { + /// + /// Initializes a new instance of the class. + /// + public ChjsTokenizationFailure() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// errors. + /// payment_profile_params. + public ChjsTokenizationFailure( + string errors, + Models.PaymentProfileParams paymentProfileParams = null) + { + this.Errors = errors; + this.PaymentProfileParams = paymentProfileParams; + } + + /// + /// Gets or sets Errors. + /// + [JsonConverter(typeof(JsonStringConverter), true)] + [JsonProperty("errors")] + [JsonRequired] + public string Errors { get; set; } + + /// + /// PCI-safe cardholder fields only. Full card numbers, CVV, and billing address are never included. + /// + [JsonProperty("payment_profile_params", NullValueHandling = NullValueHandling.Ignore)] + public Models.PaymentProfileParams PaymentProfileParams { get; set; } + + /// + public override string ToString() + { + var toStringOutput = new List(); + this.ToString(toStringOutput); + return $"ChjsTokenizationFailure : ({string.Join(", ", toStringOutput)})"; + } + + /// + public override bool Equals(object obj) + { + if (obj is null) return false; + if (ReferenceEquals(this, obj)) return true; + + return obj is ChjsTokenizationFailure other && + (this.Errors == null && other.Errors == null || + this.Errors?.Equals(other.Errors) == true) && + (this.PaymentProfileParams == null && other.PaymentProfileParams == null || + this.PaymentProfileParams?.Equals(other.PaymentProfileParams) == true) && + base.Equals(obj); + } + + /// + /// ToString overload. + /// + /// List of strings. + protected new void ToString(List toStringOutput) + { + toStringOutput.Add($"Errors = {this.Errors ?? "null"}"); + toStringOutput.Add($"PaymentProfileParams = {(this.PaymentProfileParams == null ? "null" : this.PaymentProfileParams.ToString())}"); + + base.ToString(toStringOutput); + } + } +} \ No newline at end of file diff --git a/AdvancedBilling.Standard/Models/ChjsTokenizationSuccess.cs b/AdvancedBilling.Standard/Models/ChjsTokenizationSuccess.cs new file mode 100644 index 00000000..404c37cb --- /dev/null +++ b/AdvancedBilling.Standard/Models/ChjsTokenizationSuccess.cs @@ -0,0 +1,122 @@ +// +// AdvancedBilling.Standard +// +// This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). +// +using Newtonsoft.Json; +using System.Collections.Generic; + +namespace AdvancedBilling.Standard.Models +{ + /// + /// ChjsTokenizationSuccess. + /// + public class ChjsTokenizationSuccess : BaseModel + { + private int? gatewayCustomerId; + private Dictionary shouldSerialize = new Dictionary + { + { "gateway_customer_id", false }, + }; + + /// + /// Initializes a new instance of the class. + /// + public ChjsTokenizationSuccess() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// payment_profile. + /// gateway_customer_id. + public ChjsTokenizationSuccess( + Models.TokenizedPaymentProfile paymentProfile, + int? gatewayCustomerId = null) + { + this.PaymentProfile = paymentProfile; + + if (gatewayCustomerId != null) + { + this.GatewayCustomerId = gatewayCustomerId; + } + } + + /// + /// Gets or sets PaymentProfile. + /// + [JsonProperty("payment_profile")] + [JsonRequired] + public Models.TokenizedPaymentProfile PaymentProfile { get; set; } + + /// + /// Gets or sets GatewayCustomerId. + /// + [JsonProperty("gateway_customer_id")] + public int? GatewayCustomerId + { + get + { + return this.gatewayCustomerId; + } + + set + { + this.shouldSerialize["gateway_customer_id"] = true; + this.gatewayCustomerId = value; + } + } + + /// + public override string ToString() + { + var toStringOutput = new List(); + this.ToString(toStringOutput); + return $"ChjsTokenizationSuccess : ({string.Join(", ", toStringOutput)})"; + } + + /// + /// Marks the field to not be serialized. + /// + public void UnsetGatewayCustomerId() + { + this.shouldSerialize["gateway_customer_id"] = false; + } + + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeGatewayCustomerId() + { + return this.shouldSerialize["gateway_customer_id"]; + } + + /// + public override bool Equals(object obj) + { + if (obj is null) return false; + if (ReferenceEquals(this, obj)) return true; + + return obj is ChjsTokenizationSuccess other && + (this.PaymentProfile == null && other.PaymentProfile == null || + this.PaymentProfile?.Equals(other.PaymentProfile) == true) && + (this.GatewayCustomerId == null && other.GatewayCustomerId == null || + this.GatewayCustomerId?.Equals(other.GatewayCustomerId) == true) && + base.Equals(obj); + } + + /// + /// ToString overload. + /// + /// List of strings. + protected new void ToString(List toStringOutput) + { + toStringOutput.Add($"PaymentProfile = {(this.PaymentProfile == null ? "null" : this.PaymentProfile.ToString())}"); + toStringOutput.Add($"GatewayCustomerId = {(this.GatewayCustomerId == null ? "null" : this.GatewayCustomerId.ToString())}"); + + base.ToString(toStringOutput); + } + } +} \ No newline at end of file diff --git a/AdvancedBilling.Standard/Models/Containers/EventEventSpecificData.cs b/AdvancedBilling.Standard/Models/Containers/EventEventSpecificData.cs index 14f04982..ea021c06 100644 --- a/AdvancedBilling.Standard/Models/Containers/EventEventSpecificData.cs +++ b/AdvancedBilling.Standard/Models/Containers/EventEventSpecificData.cs @@ -32,7 +32,9 @@ namespace AdvancedBilling.Standard.Models.Containers typeof(PrepaymentAccountBalanceChangedCase), typeof(PaymentCollectionMethodChangedCase), typeof(ItemPricePointChangedCase), - typeof(CustomFieldValueChangeCase) + typeof(CustomFieldValueChangeCase), + typeof(ChjsTokenizationSuccessCase), + typeof(ChjsTokenizationFailureCase) }, true )] @@ -236,6 +238,28 @@ public static EventEventSpecificData FromCustomFieldValueChange(CustomFieldValue return new CustomFieldValueChangeCase().Set(customFieldValueChange); } + /// + /// This is Chjs Tokenization Success case. + /// + /// + /// The EventEventSpecificData instance, wrapping the provided ChjsTokenizationSuccess value. + /// + public static EventEventSpecificData FromChjsTokenizationSuccess(ChjsTokenizationSuccess chjsTokenizationSuccess) + { + return new ChjsTokenizationSuccessCase().Set(chjsTokenizationSuccess); + } + + /// + /// This is Chjs Tokenization Failure case. + /// + /// + /// The EventEventSpecificData instance, wrapping the provided ChjsTokenizationFailure value. + /// + public static EventEventSpecificData FromChjsTokenizationFailure(ChjsTokenizationFailure chjsTokenizationFailure) + { + return new ChjsTokenizationFailureCase().Set(chjsTokenizationFailure); + } + /// /// Method to match from the provided one-of cases. Here parameters /// represents the callback functions for one-of type cases. All @@ -262,7 +286,9 @@ public abstract T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange); + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure); /// /// Method to match from the provided one-of cases. The parameters represent @@ -291,8 +317,10 @@ public T MatchSome( Func prepaymentAccountBalanceChanged = null, Func paymentCollectionMethodChanged = null, Func itemPricePointChanged = null, - Func customFieldValueChange = null) => - Match(subscriptionProductChange, subscriptionStateChange, paymentRelatedEvents, refundSuccess, componentAllocationChange, meteredUsage, prepaidUsage, dunningStepReached, invoiceIssued, pendingCancellationChange, prepaidSubscriptionBalanceChanged, proformaInvoiceIssued, subscriptionGroupSignupEventData, creditAccountBalanceChanged, prepaymentAccountBalanceChanged, paymentCollectionMethodChanged, itemPricePointChanged, customFieldValueChange); + Func customFieldValueChange = null, + Func chjsTokenizationSuccess = null, + Func chjsTokenizationFailure = null) => + Match(subscriptionProductChange, subscriptionStateChange, paymentRelatedEvents, refundSuccess, componentAllocationChange, meteredUsage, prepaidUsage, dunningStepReached, invoiceIssued, pendingCancellationChange, prepaidSubscriptionBalanceChanged, proformaInvoiceIssued, subscriptionGroupSignupEventData, creditAccountBalanceChanged, prepaymentAccountBalanceChanged, paymentCollectionMethodChanged, itemPricePointChanged, customFieldValueChange, chjsTokenizationSuccess, chjsTokenizationFailure); [JsonConverter(typeof(UnionTypeCaseConverter))] private sealed class SubscriptionProductChangeCase : EventEventSpecificData, ICaseValue @@ -317,7 +345,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => subscriptionProductChange != null ? subscriptionProductChange(Value) : default; public SubscriptionProductChangeCase Set(SubscriptionProductChange value) @@ -367,7 +397,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => subscriptionStateChange != null ? subscriptionStateChange(Value) : default; public SubscriptionStateChangeCase Set(SubscriptionStateChange value) @@ -417,7 +449,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => paymentRelatedEvents != null ? paymentRelatedEvents(Value) : default; public PaymentRelatedEventsCase Set(PaymentRelatedEvents value) @@ -467,7 +501,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => refundSuccess != null ? refundSuccess(Value) : default; public RefundSuccessCase Set(RefundSuccess value) @@ -517,7 +553,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => componentAllocationChange != null ? componentAllocationChange(Value) : default; public ComponentAllocationChangeCase Set(ComponentAllocationChange value) @@ -567,7 +605,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => meteredUsage != null ? meteredUsage(Value) : default; public MeteredUsageCase Set(MeteredUsage value) @@ -617,7 +657,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => prepaidUsage != null ? prepaidUsage(Value) : default; public PrepaidUsageCase Set(PrepaidUsage value) @@ -667,7 +709,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => dunningStepReached != null ? dunningStepReached(Value) : default; public DunningStepReachedCase Set(DunningStepReached value) @@ -717,7 +761,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => invoiceIssued != null ? invoiceIssued(Value) : default; public InvoiceIssuedCase Set(InvoiceIssued value) @@ -767,7 +813,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => pendingCancellationChange != null ? pendingCancellationChange(Value) : default; public PendingCancellationChangeCase Set(PendingCancellationChange value) @@ -817,7 +865,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => prepaidSubscriptionBalanceChanged != null ? prepaidSubscriptionBalanceChanged(Value) : default; public PrepaidSubscriptionBalanceChangedCase Set(PrepaidSubscriptionBalanceChanged value) @@ -867,7 +917,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => proformaInvoiceIssued != null ? proformaInvoiceIssued(Value) : default; public ProformaInvoiceIssuedCase Set(ProformaInvoiceIssued value) @@ -917,7 +969,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => subscriptionGroupSignupEventData != null ? subscriptionGroupSignupEventData(Value) : default; public SubscriptionGroupSignupEventDataCase Set(SubscriptionGroupSignupEventData value) @@ -967,7 +1021,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => creditAccountBalanceChanged != null ? creditAccountBalanceChanged(Value) : default; public CreditAccountBalanceChangedCase Set(CreditAccountBalanceChanged value) @@ -1017,7 +1073,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => prepaymentAccountBalanceChanged != null ? prepaymentAccountBalanceChanged(Value) : default; public PrepaymentAccountBalanceChangedCase Set(PrepaymentAccountBalanceChanged value) @@ -1067,7 +1125,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => paymentCollectionMethodChanged != null ? paymentCollectionMethodChanged(Value) : default; public PaymentCollectionMethodChangedCase Set(PaymentCollectionMethodChanged value) @@ -1117,7 +1177,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => itemPricePointChanged != null ? itemPricePointChanged(Value) : default; public ItemPricePointChangedCase Set(ItemPricePointChanged value) @@ -1167,7 +1229,9 @@ public override T Match( Func prepaymentAccountBalanceChanged, Func paymentCollectionMethodChanged, Func itemPricePointChanged, - Func customFieldValueChange) => + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => customFieldValueChange != null ? customFieldValueChange(Value) : default; public CustomFieldValueChangeCase Set(CustomFieldValueChange value) @@ -1193,5 +1257,109 @@ public override bool Equals(object obj) return Value == null ? other.Value == null : Value?.Equals(other.Value) == true; } } + + [JsonConverter(typeof(UnionTypeCaseConverter))] + private sealed class ChjsTokenizationSuccessCase : EventEventSpecificData, ICaseValue + { + public ChjsTokenizationSuccess Value; + + public override T Match( + Func subscriptionProductChange, + Func subscriptionStateChange, + Func paymentRelatedEvents, + Func refundSuccess, + Func componentAllocationChange, + Func meteredUsage, + Func prepaidUsage, + Func dunningStepReached, + Func invoiceIssued, + Func pendingCancellationChange, + Func prepaidSubscriptionBalanceChanged, + Func proformaInvoiceIssued, + Func subscriptionGroupSignupEventData, + Func creditAccountBalanceChanged, + Func prepaymentAccountBalanceChanged, + Func paymentCollectionMethodChanged, + Func itemPricePointChanged, + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => + chjsTokenizationSuccess != null ? chjsTokenizationSuccess(Value) : default; + + public ChjsTokenizationSuccessCase Set(ChjsTokenizationSuccess value) + { + Value = value; + return this; + } + + public ChjsTokenizationSuccess Get() + { + return Value; + } + + public override string ToString() + { + return Value?.ToString(); + } + + public override bool Equals(object obj) + { + if (!(obj is ChjsTokenizationSuccessCase other)) return false; + if (ReferenceEquals(this, other)) return true; + return Value == null ? other.Value == null : Value?.Equals(other.Value) == true; + } + } + + [JsonConverter(typeof(UnionTypeCaseConverter))] + private sealed class ChjsTokenizationFailureCase : EventEventSpecificData, ICaseValue + { + public ChjsTokenizationFailure Value; + + public override T Match( + Func subscriptionProductChange, + Func subscriptionStateChange, + Func paymentRelatedEvents, + Func refundSuccess, + Func componentAllocationChange, + Func meteredUsage, + Func prepaidUsage, + Func dunningStepReached, + Func invoiceIssued, + Func pendingCancellationChange, + Func prepaidSubscriptionBalanceChanged, + Func proformaInvoiceIssued, + Func subscriptionGroupSignupEventData, + Func creditAccountBalanceChanged, + Func prepaymentAccountBalanceChanged, + Func paymentCollectionMethodChanged, + Func itemPricePointChanged, + Func customFieldValueChange, + Func chjsTokenizationSuccess, + Func chjsTokenizationFailure) => + chjsTokenizationFailure != null ? chjsTokenizationFailure(Value) : default; + + public ChjsTokenizationFailureCase Set(ChjsTokenizationFailure value) + { + Value = value; + return this; + } + + public ChjsTokenizationFailure Get() + { + return Value; + } + + public override string ToString() + { + return Value?.ToString(); + } + + public override bool Equals(object obj) + { + if (!(obj is ChjsTokenizationFailureCase other)) return false; + if (ReferenceEquals(this, other)) return true; + return Value == null ? other.Value == null : Value?.Equals(other.Value) == true; + } + } } } \ No newline at end of file diff --git a/AdvancedBilling.Standard/Models/CreateAllocation.cs b/AdvancedBilling.Standard/Models/CreateAllocation.cs index 495b34cf..d9722b65 100644 --- a/AdvancedBilling.Standard/Models/CreateAllocation.cs +++ b/AdvancedBilling.Standard/Models/CreateAllocation.cs @@ -224,7 +224,7 @@ public CreateAllocationPricePointId PricePointId } /// - /// This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. + /// Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. /// [JsonProperty("billing_schedule", NullValueHandling = NullValueHandling.Ignore)] public Models.BillingSchedule BillingSchedule { get; set; } diff --git a/AdvancedBilling.Standard/Models/CreateInvoice.cs b/AdvancedBilling.Standard/Models/CreateInvoice.cs index fa6b2334..dc6f9a2d 100644 --- a/AdvancedBilling.Standard/Models/CreateInvoice.cs +++ b/AdvancedBilling.Standard/Models/CreateInvoice.cs @@ -66,7 +66,7 @@ public CreateInvoice( public List LineItems { get; set; } /// - /// Gets or sets IssueDate. + /// Date on which the invoice will be issued (format YYYY-MM-DD). This date is interpreted and validated in your site's time zone. It must be today or a date in the past — future dates are not accepted. If omitted, defaults to today in your site's time zone. /// [JsonConverter(typeof(CustomDateTimeConverter), "yyyy'-'MM'-'dd")] [JsonProperty("issue_date", NullValueHandling = NullValueHandling.Ignore)] diff --git a/AdvancedBilling.Standard/Models/CreatePaymentProfile.cs b/AdvancedBilling.Standard/Models/CreatePaymentProfile.cs index 6ba70f36..a611e341 100644 --- a/AdvancedBilling.Standard/Models/CreatePaymentProfile.cs +++ b/AdvancedBilling.Standard/Models/CreatePaymentProfile.cs @@ -135,7 +135,7 @@ public CreatePaymentProfile( } /// - /// Token received after sending billing information using chargify.js. + /// Token received after sending billing information using Maxio.js (formerly Chargify.js). /// [JsonProperty("chargify_token", NullValueHandling = NullValueHandling.Ignore)] public string ChargifyToken { get; set; } @@ -267,13 +267,13 @@ public string BillingAddress2 public int? CustomerId { get; set; } /// - /// used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Chargify.js instead. + /// used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Maxio.js (formerly Chargify.js) instead. /// [JsonProperty("paypal_email", NullValueHandling = NullValueHandling.Ignore)] public string PaypalEmail { get; set; } /// - /// used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Chargify.js instead. + /// used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Maxio.js (formerly Chargify.js) instead. /// [JsonProperty("payment_method_nonce", NullValueHandling = NullValueHandling.Ignore)] public string PaymentMethodNonce { get; set; } diff --git a/AdvancedBilling.Standard/Models/CreateSubscription.cs b/AdvancedBilling.Standard/Models/CreateSubscription.cs index eb1ae34f..ad744836 100644 --- a/AdvancedBilling.Standard/Models/CreateSubscription.cs +++ b/AdvancedBilling.Standard/Models/CreateSubscription.cs @@ -132,7 +132,7 @@ public CreateSubscription( Models.ACHAgreement achAgreement = null, bool? dunningCommunicationDelayEnabled = false, string dunningCommunicationDelayTimeZone = null, - bool? skipBillingManifestTaxes = false) + bool? skipBillingManifestTaxes = null) { this.ProductHandle = productHandle; this.ProductId = productId; @@ -503,7 +503,7 @@ public string DunningCommunicationDelayTimeZone } /// - /// Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests. + /// Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests. Defaults to `false` when not provided. /// [JsonProperty("skip_billing_manifest_taxes", NullValueHandling = NullValueHandling.Ignore)] public bool? SkipBillingManifestTaxes { get; set; } diff --git a/AdvancedBilling.Standard/Models/CreateUsage.cs b/AdvancedBilling.Standard/Models/CreateUsage.cs index ebbf8f00..49e30824 100644 --- a/AdvancedBilling.Standard/Models/CreateUsage.cs +++ b/AdvancedBilling.Standard/Models/CreateUsage.cs @@ -61,7 +61,7 @@ public CreateUsage( public string Memo { get; set; } /// - /// This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. + /// Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. /// [JsonProperty("billing_schedule", NullValueHandling = NullValueHandling.Ignore)] public Models.BillingSchedule BillingSchedule { get; set; } diff --git a/AdvancedBilling.Standard/Models/CreditCardPaymentProfile.cs b/AdvancedBilling.Standard/Models/CreditCardPaymentProfile.cs index 4b0704de..5a6de753 100644 --- a/AdvancedBilling.Standard/Models/CreditCardPaymentProfile.cs +++ b/AdvancedBilling.Standard/Models/CreditCardPaymentProfile.cs @@ -389,7 +389,7 @@ public string BillingAddress2 public bool? Disabled { get; set; } /// - /// Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) + /// Token received after sending billing information using Maxio.js (formerly Chargify.js). This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) /// [JsonConverter(typeof(JsonStringConverter))] [JsonProperty("chargify_token", NullValueHandling = NullValueHandling.Ignore)] diff --git a/AdvancedBilling.Standard/Models/CreditNoteLineItem.cs b/AdvancedBilling.Standard/Models/CreditNoteLineItem.cs index b655cee4..c5947c87 100644 --- a/AdvancedBilling.Standard/Models/CreditNoteLineItem.cs +++ b/AdvancedBilling.Standard/Models/CreditNoteLineItem.cs @@ -18,11 +18,13 @@ public class CreditNoteLineItem : BaseModel private int? componentId; private int? pricePointId; private int? billingScheduleItemId; + private DateTime? prepaidAllocationExpiresAt; private Dictionary shouldSerialize = new Dictionary { { "component_id", false }, { "price_point_id", false }, { "billing_schedule_item_id", false }, + { "prepaid_allocation_expires_at", false }, }; /// @@ -43,6 +45,7 @@ public CreditNoteLineItem() /// subtotal_amount. /// discount_amount. /// tax_amount. + /// tax_included. /// total_amount. /// tiered_unit_price. /// period_range_start. @@ -53,6 +56,7 @@ public CreditNoteLineItem() /// price_point_id. /// billing_schedule_item_id. /// custom_item. + /// prepaid_allocation_expires_at. public CreditNoteLineItem( string uid = null, string title = null, @@ -62,6 +66,7 @@ public CreditNoteLineItem( string subtotalAmount = null, string discountAmount = null, string taxAmount = null, + bool? taxIncluded = null, string totalAmount = null, bool? tieredUnitPrice = null, DateTime? periodRangeStart = null, @@ -71,7 +76,8 @@ public CreditNoteLineItem( int? componentId = null, int? pricePointId = null, int? billingScheduleItemId = null, - bool? customItem = null) + bool? customItem = null, + DateTime? prepaidAllocationExpiresAt = null) { this.Uid = uid; this.Title = title; @@ -81,6 +87,7 @@ public CreditNoteLineItem( this.SubtotalAmount = subtotalAmount; this.DiscountAmount = discountAmount; this.TaxAmount = taxAmount; + this.TaxIncluded = taxIncluded; this.TotalAmount = totalAmount; this.TieredUnitPrice = tieredUnitPrice; this.PeriodRangeStart = periodRangeStart; @@ -103,6 +110,11 @@ public CreditNoteLineItem( this.BillingScheduleItemId = billingScheduleItemId; } this.CustomItem = customItem; + + if (prepaidAllocationExpiresAt != null) + { + this.PrepaidAllocationExpiresAt = prepaidAllocationExpiresAt; + } } /// @@ -158,6 +170,14 @@ public CreditNoteLineItem( [JsonProperty("tax_amount", NullValueHandling = NullValueHandling.Ignore)] public string TaxAmount { get; set; } + /// + /// Whether the unit price for this line item is tax-inclusive. + /// When `true`, `unit_price` already includes tax and `tax_amount` represents the portion of the price attributable to tax. When `false`, any applicable tax is added on top of the price. + /// The value is inherited from the source price point's `tax_included` setting. Custom or ad-hoc line items (which have no associated price point) always return `false`. + /// + [JsonProperty("tax_included", NullValueHandling = NullValueHandling.Ignore)] + public bool? TaxIncluded { get; set; } + /// /// The non-canonical total amount for the line. /// `subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter. Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`. @@ -258,6 +278,25 @@ public int? BillingScheduleItemId [JsonProperty("custom_item", NullValueHandling = NullValueHandling.Ignore)] public bool? CustomItem { get; set; } + /// + /// The date a prepaid allocation is set to expire. Only present on line items representing prepaid component allocations. The format is `"YYYY-MM-DD"`. + /// + [JsonConverter(typeof(CustomDateTimeConverter), "yyyy'-'MM'-'dd")] + [JsonProperty("prepaid_allocation_expires_at")] + public DateTime? PrepaidAllocationExpiresAt + { + get + { + return this.prepaidAllocationExpiresAt; + } + + set + { + this.shouldSerialize["prepaid_allocation_expires_at"] = true; + this.prepaidAllocationExpiresAt = value; + } + } + /// public override string ToString() { @@ -287,6 +326,13 @@ public void UnsetBillingScheduleItemId() { this.shouldSerialize["billing_schedule_item_id"] = false; } + /// + /// Marks the field to not be serialized. + /// + public void UnsetPrepaidAllocationExpiresAt() + { + this.shouldSerialize["prepaid_allocation_expires_at"] = false; + } /// /// Checks if the field should be serialized or not. @@ -315,6 +361,15 @@ public bool ShouldSerializeBillingScheduleItemId() return this.shouldSerialize["billing_schedule_item_id"]; } + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializePrepaidAllocationExpiresAt() + { + return this.shouldSerialize["prepaid_allocation_expires_at"]; + } + /// public override bool Equals(object obj) { @@ -338,6 +393,8 @@ public override bool Equals(object obj) this.DiscountAmount?.Equals(other.DiscountAmount) == true) && (this.TaxAmount == null && other.TaxAmount == null || this.TaxAmount?.Equals(other.TaxAmount) == true) && + (this.TaxIncluded == null && other.TaxIncluded == null || + this.TaxIncluded?.Equals(other.TaxIncluded) == true) && (this.TotalAmount == null && other.TotalAmount == null || this.TotalAmount?.Equals(other.TotalAmount) == true) && (this.TieredUnitPrice == null && other.TieredUnitPrice == null || @@ -358,6 +415,8 @@ public override bool Equals(object obj) this.BillingScheduleItemId?.Equals(other.BillingScheduleItemId) == true) && (this.CustomItem == null && other.CustomItem == null || this.CustomItem?.Equals(other.CustomItem) == true) && + (this.PrepaidAllocationExpiresAt == null && other.PrepaidAllocationExpiresAt == null || + this.PrepaidAllocationExpiresAt?.Equals(other.PrepaidAllocationExpiresAt) == true) && base.Equals(obj); } @@ -375,6 +434,7 @@ public override bool Equals(object obj) toStringOutput.Add($"SubtotalAmount = {this.SubtotalAmount ?? "null"}"); toStringOutput.Add($"DiscountAmount = {this.DiscountAmount ?? "null"}"); toStringOutput.Add($"TaxAmount = {this.TaxAmount ?? "null"}"); + toStringOutput.Add($"TaxIncluded = {(this.TaxIncluded == null ? "null" : this.TaxIncluded.ToString())}"); toStringOutput.Add($"TotalAmount = {this.TotalAmount ?? "null"}"); toStringOutput.Add($"TieredUnitPrice = {(this.TieredUnitPrice == null ? "null" : this.TieredUnitPrice.ToString())}"); toStringOutput.Add($"PeriodRangeStart = {(this.PeriodRangeStart == null ? "null" : this.PeriodRangeStart.ToString())}"); @@ -385,6 +445,7 @@ public override bool Equals(object obj) toStringOutput.Add($"PricePointId = {(this.PricePointId == null ? "null" : this.PricePointId.ToString())}"); toStringOutput.Add($"BillingScheduleItemId = {(this.BillingScheduleItemId == null ? "null" : this.BillingScheduleItemId.ToString())}"); toStringOutput.Add($"CustomItem = {(this.CustomItem == null ? "null" : this.CustomItem.ToString())}"); + toStringOutput.Add($"PrepaidAllocationExpiresAt = {(this.PrepaidAllocationExpiresAt == null ? "null" : this.PrepaidAllocationExpiresAt.ToString())}"); base.ToString(toStringOutput); } diff --git a/AdvancedBilling.Standard/Models/Customer.cs b/AdvancedBilling.Standard/Models/Customer.cs index 3dc93ce4..091f9611 100644 --- a/AdvancedBilling.Standard/Models/Customer.cs +++ b/AdvancedBilling.Standard/Models/Customer.cs @@ -38,6 +38,7 @@ public class Customer : BaseModel private string salesforceId; private string taxExemptReason; private int? defaultAutoRenewalProfileId; + private string maxioid; private Dictionary shouldSerialize = new Dictionary { { "cc_emails", false }, @@ -63,6 +64,7 @@ public class Customer : BaseModel { "salesforce_id", false }, { "tax_exempt_reason", false }, { "default_auto_renewal_profile_id", false }, + { "maxioid", false }, }; /// @@ -105,6 +107,7 @@ public Customer() /// salesforce_id. /// tax_exempt_reason. /// default_auto_renewal_profile_id. + /// maxioid. public Customer( string firstName = null, string lastName = null, @@ -135,7 +138,8 @@ public Customer( string defaultSubscriptionGroupUid = null, string salesforceId = null, string taxExemptReason = null, - int? defaultAutoRenewalProfileId = null) + int? defaultAutoRenewalProfileId = null, + string maxioid = null) { this.FirstName = firstName; this.LastName = lastName; @@ -259,6 +263,11 @@ public Customer( { this.DefaultAutoRenewalProfileId = defaultAutoRenewalProfileId; } + + if (maxioid != null) + { + this.Maxioid = maxioid; + } } /// @@ -722,6 +731,24 @@ public int? DefaultAutoRenewalProfileId } } + /// + /// The Maxio-generated unique identifier for the customer. + /// + [JsonProperty("maxioid")] + public string Maxioid + { + get + { + return this.maxioid; + } + + set + { + this.shouldSerialize["maxioid"] = true; + this.maxioid = value; + } + } + /// public override string ToString() { @@ -891,6 +918,13 @@ public void UnsetDefaultAutoRenewalProfileId() { this.shouldSerialize["default_auto_renewal_profile_id"] = false; } + /// + /// Marks the field to not be serialized. + /// + public void UnsetMaxioid() + { + this.shouldSerialize["maxioid"] = false; + } /// /// Checks if the field should be serialized or not. @@ -1099,6 +1133,15 @@ public bool ShouldSerializeDefaultAutoRenewalProfileId() return this.shouldSerialize["default_auto_renewal_profile_id"]; } + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeMaxioid() + { + return this.shouldSerialize["maxioid"]; + } + /// public override bool Equals(object obj) { @@ -1166,6 +1209,8 @@ public override bool Equals(object obj) this.TaxExemptReason?.Equals(other.TaxExemptReason) == true) && (this.DefaultAutoRenewalProfileId == null && other.DefaultAutoRenewalProfileId == null || this.DefaultAutoRenewalProfileId?.Equals(other.DefaultAutoRenewalProfileId) == true) && + (this.Maxioid == null && other.Maxioid == null || + this.Maxioid?.Equals(other.Maxioid) == true) && base.Equals(obj); } @@ -1205,6 +1250,7 @@ public override bool Equals(object obj) toStringOutput.Add($"SalesforceId = {this.SalesforceId ?? "null"}"); toStringOutput.Add($"TaxExemptReason = {this.TaxExemptReason ?? "null"}"); toStringOutput.Add($"DefaultAutoRenewalProfileId = {(this.DefaultAutoRenewalProfileId == null ? "null" : this.DefaultAutoRenewalProfileId.ToString())}"); + toStringOutput.Add($"Maxioid = {this.Maxioid ?? "null"}"); base.ToString(toStringOutput); } diff --git a/AdvancedBilling.Standard/Models/Event.cs b/AdvancedBilling.Standard/Models/Event.cs index 98bac384..b3254a8d 100644 --- a/AdvancedBilling.Standard/Models/Event.cs +++ b/AdvancedBilling.Standard/Models/Event.cs @@ -108,6 +108,8 @@ public Event( /// * `subscription_service_credit_account_balance_changed` - CreditAccountBalanceChanged /// * `item_price_point_changed` - ItemPricePointChanged /// * `custom_field_value_change` - CustomFieldValueChange + /// * `chjs_tokenization_success` - ChjsTokenizationSuccess + /// * `chjs_tokenization_failure` - ChjsTokenizationFailure /// * The rest, that is `delayed_signup_creation_failure`, `billing_date_change`, `expiration_date_change`, `expiring_card`, /// `customer_update`, `customer_create`, `customer_delete`, `upgrade_downgrade_success`, `upgrade_downgrade_failure`, /// `statement_closed`, `statement_settled`, `subscription_card_update`, `subscription_group_card_update`, diff --git a/AdvancedBilling.Standard/Models/EventKey.cs b/AdvancedBilling.Standard/Models/EventKey.cs index 5ca76415..9ea46cf5 100644 --- a/AdvancedBilling.Standard/Models/EventKey.cs +++ b/AdvancedBilling.Standard/Models/EventKey.cs @@ -214,6 +214,12 @@ public enum EventKey [EnumMember(Value = "invoice_issued")] InvoiceIssued, + /// + /// InvoicePending. + /// + [EnumMember(Value = "invoice_pending")] + InvoicePending, + /// /// PrepaidSubscriptionBalanceChanged. /// @@ -472,6 +478,18 @@ public enum EventKey [EnumMember(Value = "component_billing_date_changed")] ComponentBillingDateChanged, + /// + /// ChjsTokenizationFailure. + /// + [EnumMember(Value = "chjs_tokenization_failure")] + ChjsTokenizationFailure, + + /// + /// ChjsTokenizationSuccess. + /// + [EnumMember(Value = "chjs_tokenization_success")] + ChjsTokenizationSuccess, + /// /// SubscriptionTermRenewalScheduled. /// diff --git a/AdvancedBilling.Standard/Models/InvoiceLineItem.cs b/AdvancedBilling.Standard/Models/InvoiceLineItem.cs index 8a23a937..f7f5ddf8 100644 --- a/AdvancedBilling.Standard/Models/InvoiceLineItem.cs +++ b/AdvancedBilling.Standard/Models/InvoiceLineItem.cs @@ -22,6 +22,7 @@ public class InvoiceLineItem : BaseModel private int? billingScheduleItemId; private Models.InvoiceLineItemComponentCostData componentCostData; private int? productPricePointId; + private DateTime? prepaidAllocationExpiresAt; private Dictionary shouldSerialize = new Dictionary { { "product_id", false }, @@ -31,6 +32,7 @@ public class InvoiceLineItem : BaseModel { "billing_schedule_item_id", false }, { "component_cost_data", false }, { "product_price_point_id", false }, + { "prepaid_allocation_expires_at", false }, }; /// @@ -51,6 +53,7 @@ public InvoiceLineItem() /// subtotal_amount. /// discount_amount. /// tax_amount. + /// tax_included. /// total_amount. /// tiered_unit_price. /// period_range_start. @@ -66,6 +69,7 @@ public InvoiceLineItem() /// product_price_point_id. /// custom_item. /// kind. + /// prepaid_allocation_expires_at. public InvoiceLineItem( string uid = null, string title = null, @@ -75,6 +79,7 @@ public InvoiceLineItem( string subtotalAmount = null, string discountAmount = null, string taxAmount = null, + bool? taxIncluded = null, string totalAmount = null, bool? tieredUnitPrice = null, DateTime? periodRangeStart = null, @@ -89,7 +94,8 @@ public InvoiceLineItem( Models.InvoiceLineItemComponentCostData componentCostData = null, int? productPricePointId = null, bool? customItem = null, - string kind = null) + string kind = null, + DateTime? prepaidAllocationExpiresAt = null) { this.Uid = uid; this.Title = title; @@ -99,6 +105,7 @@ public InvoiceLineItem( this.SubtotalAmount = subtotalAmount; this.DiscountAmount = discountAmount; this.TaxAmount = taxAmount; + this.TaxIncluded = taxIncluded; this.TotalAmount = totalAmount; this.TieredUnitPrice = tieredUnitPrice; this.PeriodRangeStart = periodRangeStart; @@ -142,6 +149,11 @@ public InvoiceLineItem( } this.CustomItem = customItem; this.Kind = kind; + + if (prepaidAllocationExpiresAt != null) + { + this.PrepaidAllocationExpiresAt = prepaidAllocationExpiresAt; + } } /// @@ -197,6 +209,14 @@ public InvoiceLineItem( [JsonProperty("tax_amount", NullValueHandling = NullValueHandling.Ignore)] public string TaxAmount { get; set; } + /// + /// Whether the unit price for this line item is tax-inclusive. + /// When `true`, `unit_price` already includes tax and `tax_amount` represents the portion of the price attributable to tax. When `false`, any applicable tax is added on top of the price. + /// The value is inherited from the source price point's `tax_included` setting. Custom or ad-hoc line items (which have no associated price point) always return `false`. + /// + [JsonProperty("tax_included", NullValueHandling = NullValueHandling.Ignore)] + public bool? TaxIncluded { get; set; } + /// /// The non-canonical total amount for the line. /// `subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter. Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`. @@ -381,6 +401,25 @@ public int? ProductPricePointId [JsonProperty("kind", NullValueHandling = NullValueHandling.Ignore)] public string Kind { get; set; } + /// + /// The date a prepaid allocation is set to expire. Only present on line items representing prepaid component allocations. The format is `"YYYY-MM-DD"`. + /// + [JsonConverter(typeof(CustomDateTimeConverter), "yyyy'-'MM'-'dd")] + [JsonProperty("prepaid_allocation_expires_at")] + public DateTime? PrepaidAllocationExpiresAt + { + get + { + return this.prepaidAllocationExpiresAt; + } + + set + { + this.shouldSerialize["prepaid_allocation_expires_at"] = true; + this.prepaidAllocationExpiresAt = value; + } + } + /// public override string ToString() { @@ -438,6 +477,13 @@ public void UnsetProductPricePointId() { this.shouldSerialize["product_price_point_id"] = false; } + /// + /// Marks the field to not be serialized. + /// + public void UnsetPrepaidAllocationExpiresAt() + { + this.shouldSerialize["prepaid_allocation_expires_at"] = false; + } /// /// Checks if the field should be serialized or not. @@ -502,6 +548,15 @@ public bool ShouldSerializeProductPricePointId() return this.shouldSerialize["product_price_point_id"]; } + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializePrepaidAllocationExpiresAt() + { + return this.shouldSerialize["prepaid_allocation_expires_at"]; + } + /// public override bool Equals(object obj) { @@ -525,6 +580,8 @@ public override bool Equals(object obj) this.DiscountAmount?.Equals(other.DiscountAmount) == true) && (this.TaxAmount == null && other.TaxAmount == null || this.TaxAmount?.Equals(other.TaxAmount) == true) && + (this.TaxIncluded == null && other.TaxIncluded == null || + this.TaxIncluded?.Equals(other.TaxIncluded) == true) && (this.TotalAmount == null && other.TotalAmount == null || this.TotalAmount?.Equals(other.TotalAmount) == true) && (this.TieredUnitPrice == null && other.TieredUnitPrice == null || @@ -555,6 +612,8 @@ public override bool Equals(object obj) this.CustomItem?.Equals(other.CustomItem) == true) && (this.Kind == null && other.Kind == null || this.Kind?.Equals(other.Kind) == true) && + (this.PrepaidAllocationExpiresAt == null && other.PrepaidAllocationExpiresAt == null || + this.PrepaidAllocationExpiresAt?.Equals(other.PrepaidAllocationExpiresAt) == true) && base.Equals(obj); } @@ -572,6 +631,7 @@ public override bool Equals(object obj) toStringOutput.Add($"SubtotalAmount = {this.SubtotalAmount ?? "null"}"); toStringOutput.Add($"DiscountAmount = {this.DiscountAmount ?? "null"}"); toStringOutput.Add($"TaxAmount = {this.TaxAmount ?? "null"}"); + toStringOutput.Add($"TaxIncluded = {(this.TaxIncluded == null ? "null" : this.TaxIncluded.ToString())}"); toStringOutput.Add($"TotalAmount = {this.TotalAmount ?? "null"}"); toStringOutput.Add($"TieredUnitPrice = {(this.TieredUnitPrice == null ? "null" : this.TieredUnitPrice.ToString())}"); toStringOutput.Add($"PeriodRangeStart = {(this.PeriodRangeStart == null ? "null" : this.PeriodRangeStart.ToString())}"); @@ -587,6 +647,7 @@ public override bool Equals(object obj) toStringOutput.Add($"ProductPricePointId = {(this.ProductPricePointId == null ? "null" : this.ProductPricePointId.ToString())}"); toStringOutput.Add($"CustomItem = {(this.CustomItem == null ? "null" : this.CustomItem.ToString())}"); toStringOutput.Add($"Kind = {this.Kind ?? "null"}"); + toStringOutput.Add($"PrepaidAllocationExpiresAt = {(this.PrepaidAllocationExpiresAt == null ? "null" : this.PrepaidAllocationExpiresAt.ToString())}"); base.ToString(toStringOutput); } diff --git a/AdvancedBilling.Standard/Models/PaymentProfileAttributes.cs b/AdvancedBilling.Standard/Models/PaymentProfileAttributes.cs index f3259471..8609db2b 100644 --- a/AdvancedBilling.Standard/Models/PaymentProfileAttributes.cs +++ b/AdvancedBilling.Standard/Models/PaymentProfileAttributes.cs @@ -114,7 +114,7 @@ public PaymentProfileAttributes( } /// - /// (Optional) Token received after sending billing information using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) + /// (Optional) Token received after sending billing information using Maxio.js (formerly Chargify.js). This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) /// [JsonProperty("chargify_token", NullValueHandling = NullValueHandling.Ignore)] public string ChargifyToken { get; set; } diff --git a/AdvancedBilling.Standard/Models/PaymentProfileParams.cs b/AdvancedBilling.Standard/Models/PaymentProfileParams.cs new file mode 100644 index 00000000..cb1c9228 --- /dev/null +++ b/AdvancedBilling.Standard/Models/PaymentProfileParams.cs @@ -0,0 +1,94 @@ +// +// AdvancedBilling.Standard +// +// This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). +// +using Newtonsoft.Json; +using System.Collections.Generic; + +namespace AdvancedBilling.Standard.Models +{ + /// + /// PaymentProfileParams. + /// + public class PaymentProfileParams : BaseModel + { + /// + /// Initializes a new instance of the class. + /// + public PaymentProfileParams() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// first_name. + /// last_name. + /// card_type. + public PaymentProfileParams( + string firstName = null, + string lastName = null, + string cardType = null) + { + this.FirstName = firstName; + this.LastName = lastName; + this.CardType = cardType; + } + + /// + /// Gets or sets FirstName. + /// + [JsonProperty("first_name", NullValueHandling = NullValueHandling.Ignore)] + public string FirstName { get; set; } + + /// + /// Gets or sets LastName. + /// + [JsonProperty("last_name", NullValueHandling = NullValueHandling.Ignore)] + public string LastName { get; set; } + + /// + /// Gets or sets CardType. + /// + [JsonProperty("card_type", NullValueHandling = NullValueHandling.Ignore)] + public string CardType { get; set; } + + /// + public override string ToString() + { + var toStringOutput = new List(); + this.ToString(toStringOutput); + return $"PaymentProfileParams : ({string.Join(", ", toStringOutput)})"; + } + + /// + public override bool Equals(object obj) + { + if (obj is null) return false; + if (ReferenceEquals(this, obj)) return true; + + return obj is PaymentProfileParams other && + (this.FirstName == null && other.FirstName == null || + this.FirstName?.Equals(other.FirstName) == true) && + (this.LastName == null && other.LastName == null || + this.LastName?.Equals(other.LastName) == true) && + (this.CardType == null && other.CardType == null || + this.CardType?.Equals(other.CardType) == true) && + base.Equals(obj); + } + + /// + /// ToString overload. + /// + /// List of strings. + protected new void ToString(List toStringOutput) + { + toStringOutput.Add($"FirstName = {this.FirstName ?? "null"}"); + toStringOutput.Add($"LastName = {this.LastName ?? "null"}"); + toStringOutput.Add($"CardType = {this.CardType ?? "null"}"); + + base.ToString(toStringOutput); + } + } +} \ No newline at end of file diff --git a/AdvancedBilling.Standard/Models/Site.cs b/AdvancedBilling.Standard/Models/Site.cs index aed602d8..a9a848c4 100644 --- a/AdvancedBilling.Standard/Models/Site.cs +++ b/AdvancedBilling.Standard/Models/Site.cs @@ -39,6 +39,9 @@ public Site() /// organization_address. /// tax_configuration. /// net_terms. + /// multi_frequency_enabled. + /// auto_renewals_enabled. + /// portal_enabled. /// test. public Site( int? id = null, @@ -57,6 +60,9 @@ public Site( Models.OrganizationAddress organizationAddress = null, Models.TaxConfiguration taxConfiguration = null, Models.NetTerms netTerms = null, + bool? multiFrequencyEnabled = null, + bool? autoRenewalsEnabled = null, + bool? portalEnabled = null, bool? test = null) { this.Id = id; @@ -75,6 +81,9 @@ public Site( this.OrganizationAddress = organizationAddress; this.TaxConfiguration = taxConfiguration; this.NetTerms = netTerms; + this.MultiFrequencyEnabled = multiFrequencyEnabled; + this.AutoRenewalsEnabled = autoRenewalsEnabled; + this.PortalEnabled = portalEnabled; this.Test = test; } @@ -174,6 +183,24 @@ public Site( [JsonProperty("net_terms", NullValueHandling = NullValueHandling.Ignore)] public Models.NetTerms NetTerms { get; set; } + /// + /// Whether the site has the multi-frequency billing feature enabled. Only present when relationship invoicing is active. + /// + [JsonProperty("multi_frequency_enabled", NullValueHandling = NullValueHandling.Ignore)] + public bool? MultiFrequencyEnabled { get; set; } + + /// + /// Whether the auto-renewals feature is enabled for this site. + /// + [JsonProperty("auto_renewals_enabled", NullValueHandling = NullValueHandling.Ignore)] + public bool? AutoRenewalsEnabled { get; set; } + + /// + /// Whether the Billing Portal is enabled for this site. + /// + [JsonProperty("portal_enabled", NullValueHandling = NullValueHandling.Ignore)] + public bool? PortalEnabled { get; set; } + /// /// Gets or sets Test. /// @@ -227,6 +254,12 @@ public override bool Equals(object obj) this.TaxConfiguration?.Equals(other.TaxConfiguration) == true) && (this.NetTerms == null && other.NetTerms == null || this.NetTerms?.Equals(other.NetTerms) == true) && + (this.MultiFrequencyEnabled == null && other.MultiFrequencyEnabled == null || + this.MultiFrequencyEnabled?.Equals(other.MultiFrequencyEnabled) == true) && + (this.AutoRenewalsEnabled == null && other.AutoRenewalsEnabled == null || + this.AutoRenewalsEnabled?.Equals(other.AutoRenewalsEnabled) == true) && + (this.PortalEnabled == null && other.PortalEnabled == null || + this.PortalEnabled?.Equals(other.PortalEnabled) == true) && (this.Test == null && other.Test == null || this.Test?.Equals(other.Test) == true) && base.Equals(obj); @@ -254,6 +287,9 @@ public override bool Equals(object obj) toStringOutput.Add($"OrganizationAddress = {(this.OrganizationAddress == null ? "null" : this.OrganizationAddress.ToString())}"); toStringOutput.Add($"TaxConfiguration = {(this.TaxConfiguration == null ? "null" : this.TaxConfiguration.ToString())}"); toStringOutput.Add($"NetTerms = {(this.NetTerms == null ? "null" : this.NetTerms.ToString())}"); + toStringOutput.Add($"MultiFrequencyEnabled = {(this.MultiFrequencyEnabled == null ? "null" : this.MultiFrequencyEnabled.ToString())}"); + toStringOutput.Add($"AutoRenewalsEnabled = {(this.AutoRenewalsEnabled == null ? "null" : this.AutoRenewalsEnabled.ToString())}"); + toStringOutput.Add($"PortalEnabled = {(this.PortalEnabled == null ? "null" : this.PortalEnabled.ToString())}"); toStringOutput.Add($"Test = {(this.Test == null ? "null" : this.Test.ToString())}"); base.ToString(toStringOutput); diff --git a/AdvancedBilling.Standard/Models/TokenizedPaymentProfile.cs b/AdvancedBilling.Standard/Models/TokenizedPaymentProfile.cs new file mode 100644 index 00000000..4cc51dc5 --- /dev/null +++ b/AdvancedBilling.Standard/Models/TokenizedPaymentProfile.cs @@ -0,0 +1,178 @@ +// +// AdvancedBilling.Standard +// +// This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ). +// +using Newtonsoft.Json; +using System.Collections.Generic; + +namespace AdvancedBilling.Standard.Models +{ + /// + /// TokenizedPaymentProfile. + /// + public class TokenizedPaymentProfile : BaseModel + { + private string gatewayHandle; + private string customerVaultToken; + private Dictionary shouldSerialize = new Dictionary + { + { "gateway_handle", false }, + { "customer_vault_token", false }, + }; + + /// + /// Initializes a new instance of the class. + /// + public TokenizedPaymentProfile() + { + } + + /// + /// Initializes a new instance of the class. + /// + /// id. + /// vault_token. + /// gateway_handle. + /// customer_vault_token. + public TokenizedPaymentProfile( + int id, + string vaultToken = null, + string gatewayHandle = null, + string customerVaultToken = null) + { + this.Id = id; + this.VaultToken = vaultToken; + + if (gatewayHandle != null) + { + this.GatewayHandle = gatewayHandle; + } + + if (customerVaultToken != null) + { + this.CustomerVaultToken = customerVaultToken; + } + } + + /// + /// Gets or sets Id. + /// + [JsonProperty("id")] + public int Id { get; set; } + + /// + /// Gets or sets VaultToken. + /// + [JsonProperty("vault_token", NullValueHandling = NullValueHandling.Ignore)] + public string VaultToken { get; set; } + + /// + /// Gets or sets GatewayHandle. + /// + [JsonProperty("gateway_handle")] + public string GatewayHandle + { + get + { + return this.gatewayHandle; + } + + set + { + this.shouldSerialize["gateway_handle"] = true; + this.gatewayHandle = value; + } + } + + /// + /// Gets or sets CustomerVaultToken. + /// + [JsonProperty("customer_vault_token")] + public string CustomerVaultToken + { + get + { + return this.customerVaultToken; + } + + set + { + this.shouldSerialize["customer_vault_token"] = true; + this.customerVaultToken = value; + } + } + + /// + public override string ToString() + { + var toStringOutput = new List(); + this.ToString(toStringOutput); + return $"TokenizedPaymentProfile : ({string.Join(", ", toStringOutput)})"; + } + + /// + /// Marks the field to not be serialized. + /// + public void UnsetGatewayHandle() + { + this.shouldSerialize["gateway_handle"] = false; + } + /// + /// Marks the field to not be serialized. + /// + public void UnsetCustomerVaultToken() + { + this.shouldSerialize["customer_vault_token"] = false; + } + + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeGatewayHandle() + { + return this.shouldSerialize["gateway_handle"]; + } + + /// + /// Checks if the field should be serialized or not. + /// + /// A boolean weather the field should be serialized or not. + public bool ShouldSerializeCustomerVaultToken() + { + return this.shouldSerialize["customer_vault_token"]; + } + + /// + public override bool Equals(object obj) + { + if (obj is null) return false; + if (ReferenceEquals(this, obj)) return true; + + return obj is TokenizedPaymentProfile other && + (this.Id.Equals(other.Id)) && + (this.VaultToken == null && other.VaultToken == null || + this.VaultToken?.Equals(other.VaultToken) == true) && + (this.GatewayHandle == null && other.GatewayHandle == null || + this.GatewayHandle?.Equals(other.GatewayHandle) == true) && + (this.CustomerVaultToken == null && other.CustomerVaultToken == null || + this.CustomerVaultToken?.Equals(other.CustomerVaultToken) == true) && + base.Equals(obj); + } + + /// + /// ToString overload. + /// + /// List of strings. + protected new void ToString(List toStringOutput) + { + toStringOutput.Add($"Id = {this.Id}"); + toStringOutput.Add($"VaultToken = {this.VaultToken ?? "null"}"); + toStringOutput.Add($"GatewayHandle = {this.GatewayHandle ?? "null"}"); + toStringOutput.Add($"CustomerVaultToken = {this.CustomerVaultToken ?? "null"}"); + + base.ToString(toStringOutput); + } + } +} \ No newline at end of file diff --git a/AdvancedBilling.Standard/Models/WebhookSubscription.cs b/AdvancedBilling.Standard/Models/WebhookSubscription.cs index 0b0ae8ff..605b32fb 100644 --- a/AdvancedBilling.Standard/Models/WebhookSubscription.cs +++ b/AdvancedBilling.Standard/Models/WebhookSubscription.cs @@ -28,6 +28,18 @@ public enum WebhookSubscription [EnumMember(Value = "component_allocation_change")] ComponentAllocationChange, + /// + /// ChjsTokenizationFailure. + /// + [EnumMember(Value = "chjs_tokenization_failure")] + ChjsTokenizationFailure, + + /// + /// ChjsTokenizationSuccess. + /// + [EnumMember(Value = "chjs_tokenization_success")] + ChjsTokenizationSuccess, + /// /// CustomerCreate. /// @@ -64,6 +76,12 @@ public enum WebhookSubscription [EnumMember(Value = "invoice_issued")] InvoiceIssued, + /// + /// InvoicePending. + /// + [EnumMember(Value = "invoice_pending")] + InvoicePending, + /// /// MeteredUsage. /// diff --git a/AdvancedBilling.sln b/AdvancedBilling.sln index 7c22534f..1327c630 100644 --- a/AdvancedBilling.sln +++ b/AdvancedBilling.sln @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 VisualStudioVersion = 15.0.26430.14 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AdvancedBilling.Standard", "AdvancedBilling.Standard/AdvancedBilling.Standard.csproj", "{5856bb1d-340a-416b-a313-eef8ab4f51ba}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AdvancedBilling.Standard", "AdvancedBilling.Standard/AdvancedBilling.Standard.csproj", "{1e7f1da0-0b75-41d6-ac32-960d708c0884}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -10,10 +10,10 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {5856bb1d-340a-416b-a313-eef8ab4f51ba}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {5856bb1d-340a-416b-a313-eef8ab4f51ba}.Debug|Any CPU.Build.0 = Debug|Any CPU - {5856bb1d-340a-416b-a313-eef8ab4f51ba}.Release|Any CPU.ActiveCfg = Release|Any CPU - {5856bb1d-340a-416b-a313-eef8ab4f51ba}.Release|Any CPU.Build.0 = Release|Any CPU + {1e7f1da0-0b75-41d6-ac32-960d708c0884}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1e7f1da0-0b75-41d6-ac32-960d708c0884}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1e7f1da0-0b75-41d6-ac32-960d708c0884}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1e7f1da0-0b75-41d6-ac32-960d708c0884}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/README.md b/README.md index 18744b62..09f5e490 100644 --- a/README.md +++ b/README.md @@ -29,25 +29,25 @@ curl -u :x -H Accept:application/json -H Content-Type:application/json If you are building with .NET CLI tools then you can also use the following command: ```bash -dotnet add package Maxio.AdvancedBillingSdk --version 9.0.0 +dotnet add package Maxio.AdvancedBillingSdk --version 9.1.0 ``` You can also view the package at: -https://www.nuget.org/packages/Maxio.AdvancedBillingSdk/9.0.0 +https://www.nuget.org/packages/Maxio.AdvancedBillingSdk/9.1.0 ## Initialize the API Client -**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/client.md) +**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/client.md) The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | | Site | `string` | The subdomain for your Advanced Billing site.
*Default*: `"subdomain"` | -| Environment | [`Environment`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/README.md#environments) | The API environment.
**Default: `Environment.US`** | +| Environment | [`Environment`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/README.md#environments) | The API environment.
**Default: `Environment.US`** | | Timeout | `TimeSpan` | Http client timeout.
*Default*: `TimeSpan.FromSeconds(120)` | -| HttpClientConfiguration | [`Action`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-client-configuration-builder.md) | Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings.
*Default*: `new HttpClient()` | -| BasicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication | +| HttpClientConfiguration | [`Action`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-client-configuration-builder.md) | Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings.
*Default*: `new HttpClient()` | +| BasicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication | The API client can be initialized as follows: @@ -92,7 +92,7 @@ var client = AdvancedBillingClient .FromConfiguration(configuration.GetSection("AdvancedBilling")); ``` -See the [Configuration-Based Initialization](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/configuration-based-initialization.md) section for details. +See the [Configuration-Based Initialization](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/configuration-based-initialization.md) section for details. ## Environments @@ -109,65 +109,65 @@ The SDK can be configured to use a different environment for making API calls. A This API uses the following authentication schemes. -* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/auth/basic-authentication.md) +* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/auth/basic-authentication.md) ## List of APIs -* [API Exports](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/api-exports.md) -* [Advance Invoice](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/advance-invoice.md) -* [Billing Portal](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/billing-portal.md) -* [Component Price Points](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/component-price-points.md) -* [Custom Fields](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/custom-fields.md) -* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/events-based-billing-segments.md) -* [Payment Profiles](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/payment-profiles.md) -* [Product Families](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/product-families.md) -* [Product Price Points](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/product-price-points.md) -* [Proforma Invoices](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/proforma-invoices.md) -* [Reason Codes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/reason-codes.md) -* [Referral Codes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/referral-codes.md) -* [Sales Commissions](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/sales-commissions.md) -* [Subscription Components](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-components.md) -* [Subscription Groups](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-groups.md) -* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-group-invoice-account.md) -* [Subscription Group Status](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-group-status.md) -* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-invoice-account.md) -* [Subscription Notes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-notes.md) -* [Subscription Products](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-products.md) -* [Subscription Renewals](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-renewals.md) -* [Subscription Status](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscription-status.md) -* [Coupons](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/coupons.md) -* [Components](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/components.md) -* [Customers](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/customers.md) -* [Events](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/events.md) -* [Insights](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/insights.md) -* [Invoices](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/invoices.md) -* [Offers](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/offers.md) -* [Products](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/products.md) -* [Sites](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/sites.md) -* [Subscriptions](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/subscriptions.md) -* [Webhooks](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/controllers/webhooks.md) +* [API Exports](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/api-exports.md) +* [Advance Invoice](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/advance-invoice.md) +* [Billing Portal](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/billing-portal.md) +* [Component Price Points](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/component-price-points.md) +* [Custom Fields](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/custom-fields.md) +* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/events-based-billing-segments.md) +* [Payment Profiles](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/payment-profiles.md) +* [Product Families](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/product-families.md) +* [Product Price Points](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/product-price-points.md) +* [Proforma Invoices](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/proforma-invoices.md) +* [Reason Codes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/reason-codes.md) +* [Referral Codes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/referral-codes.md) +* [Sales Commissions](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/sales-commissions.md) +* [Subscription Components](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-components.md) +* [Subscription Groups](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-groups.md) +* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-group-invoice-account.md) +* [Subscription Group Status](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-group-status.md) +* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-invoice-account.md) +* [Subscription Notes](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-notes.md) +* [Subscription Products](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-products.md) +* [Subscription Renewals](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-renewals.md) +* [Subscription Status](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscription-status.md) +* [Coupons](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/coupons.md) +* [Components](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/components.md) +* [Customers](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/customers.md) +* [Events](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/events.md) +* [Insights](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/insights.md) +* [Invoices](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/invoices.md) +* [Offers](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/offers.md) +* [Products](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/products.md) +* [Sites](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/sites.md) +* [Subscriptions](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/subscriptions.md) +* [Webhooks](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/controllers/webhooks.md) ## SDK Infrastructure ### Configuration -* [Configuration-Based Initialization](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/configuration-based-initialization.md) -* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-client-configuration.md) -* [HttpClientConfigurationBuilder](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-client-configuration-builder.md) -* [ProxyConfigurationBuilder](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/proxy-configuration-builder.md) +* [Configuration-Based Initialization](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/configuration-based-initialization.md) +* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-client-configuration.md) +* [HttpClientConfigurationBuilder](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-client-configuration-builder.md) +* [ProxyConfigurationBuilder](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/proxy-configuration-builder.md) ### HTTP -* [HttpCallback](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-callback.md) -* [HttpContext](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-context.md) -* [HttpRequest](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-request.md) -* [HttpResponse](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-response.md) -* [HttpStringResponse](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/http-string-response.md) +* [HttpCallback](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-callback.md) +* [HttpContext](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-context.md) +* [HttpRequest](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-request.md) +* [HttpResponse](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-response.md) +* [HttpStringResponse](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/http-string-response.md) ### Utilities -* [ApiException](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/api-exception.md) -* [ApiHelper](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/api-helper.md) -* [CustomDateTimeConverter](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/custom-date-time-converter.md) -* [UnixDateTimeConverter](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.0.0/doc/unix-date-time-converter.md) +* [ApiException](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/api-exception.md) +* [ApiHelper](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/api-helper.md) +* [CustomDateTimeConverter](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/custom-date-time-converter.md) +* [UnixDateTimeConverter](https://www.github.com/maxio-com/ab-dotnet-sdk/tree/9.1.0/doc/unix-date-time-converter.md) diff --git a/doc/controllers/advance-invoice.md b/doc/controllers/advance-invoice.md index fe76a902..f63fa5b4 100644 --- a/doc/controllers/advance-invoice.md +++ b/doc/controllers/advance-invoice.md @@ -17,7 +17,7 @@ AdvanceInvoiceController advanceInvoiceController = client.AdvanceInvoiceControl # Issue Advance Invoice -Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility on generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. +Generate an invoice in advance for a subscription's next renewal date. [See our docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Invoice-In-Advance) for more information on advance invoices, including eligibility for generating one; for the most part, they function like any other invoice, except they are issued early and have special behavior upon being voided. A subscription may only have one advance invoice per billing period. Attempting to issue an advance invoice when one already exists will return an error. That said, regeneration of the invoice may be forced with the params `force: true`, which will void an advance invoice if one exists and generate a new one. If no advance invoice exists, a new one will be generated. We recommend using either the create or preview endpoints for proforma invoices to preview this advance invoice before using this endpoint to generate it. @@ -28,6 +28,10 @@ IssueAdvanceInvoiceAsync( Models.IssueAdvanceInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -37,6 +41,8 @@ IssueAdvanceInvoiceAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -75,13 +81,17 @@ catch (ApiException e) # Read Advance Invoice -Once an advance invoice has been generated for a subscription's upcoming renewal, it can be viewed through this endpoint. There can only be one advance invoice per subscription per billing cycle. +Returns the advance invoice generated for a subscription's upcoming renewal. There can only be one advance invoice per subscription per billing cycle. ```csharp ReadAdvanceInvoiceAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -90,6 +100,8 @@ ReadAdvanceInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -124,6 +136,10 @@ VoidAdvanceInvoiceAsync( Models.VoidInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -133,6 +149,8 @@ VoidAdvanceInvoiceAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/invoice.md) ## Example Usage diff --git a/doc/controllers/api-exports.md b/doc/controllers/api-exports.md index 49584ef3..7d67b60b 100644 --- a/doc/controllers/api-exports.md +++ b/doc/controllers/api-exports.md @@ -23,7 +23,7 @@ APIExportsController aPIExportsController = client.APIExportsController; # List Exported Proforma Invoices -This API returns an array of exported proforma invoices for a provided `batch_id`. Pay close attention to pagination in order to control responses from the server. +Lists exported proforma invoices for a provided `batch_id`. Use pagination to control responses returned from the server. Example: `GET https://{subdomain}.chargify.com/api_exports/proforma_invoices/123/rows?per_page=10000&page=1`. @@ -32,6 +32,10 @@ ListExportedProformaInvoicesAsync( Models.ListExportedProformaInvoicesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -40,6 +44,8 @@ ListExportedProformaInvoicesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -71,7 +77,7 @@ catch (ApiException e) # List Exported Invoices -This API returns an array of exported invoices for a provided `batch_id`. Pay close attention to pagination in order to control responses from the server. +Lists exported invoices for a provided `batch_id`. Use pagination to control responses returned from the server. Example: `GET https://{subdomain}.chargify.com/api_exports/invoices/123/rows?per_page=10000&page=1`. @@ -80,6 +86,10 @@ ListExportedInvoicesAsync( Models.ListExportedInvoicesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -88,6 +98,8 @@ ListExportedInvoicesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/invoice.md) ## Example Usage @@ -119,7 +131,7 @@ catch (ApiException e) # List Exported Subscriptions -This API returns an array of exported subscriptions for a provided `batch_id`. Pay close attention to pagination in order to control responses from the server. +Lists exported subscriptions for a provided `batch_id`. Use pagination to control responses returned from the server. Example: `GET https://{subdomain}.chargify.com/api_exports/subscriptions/123/rows?per_page=200&page=1`. @@ -128,6 +140,10 @@ ListExportedSubscriptionsAsync( Models.ListExportedSubscriptionsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -136,6 +152,8 @@ ListExportedSubscriptionsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/subscription.md) ## Example Usage @@ -167,7 +185,7 @@ catch (ApiException e) # Export Proforma Invoices -This API creates a proforma invoices export and returns a batchjob object. +Creates a proforma invoices export and returns a batch job object. It is only available for Relationship Invoicing architecture. @@ -175,8 +193,14 @@ It is only available for Relationship Invoicing architecture. ExportProformaInvoicesAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**201**: Created + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage @@ -206,14 +230,20 @@ catch (ApiException e) # Export Invoices -This API creates an invoices export and returns a batchjob object. +Creates an invoices export and returns a batch job object. ```csharp ExportInvoicesAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**201**: Created + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage @@ -243,14 +273,20 @@ catch (ApiException e) # Export Subscriptions -This API creates a subscriptions export and returns a batchjob object. +Creates a subscriptions export and returns a batch job object. ```csharp ExportSubscriptionsAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**201**: Created + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage @@ -279,13 +315,17 @@ catch (ApiException e) # Read Proforma Invoices Export -This API returns a batchjob object for proforma invoices export. +Returns a batch job object for a proforma invoices export. ```csharp ReadProformaInvoicesExportAsync( string batchId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -294,6 +334,8 @@ ReadProformaInvoicesExportAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage @@ -319,13 +361,17 @@ catch (ApiException e) # Read Invoices Export -This API returns a batchjob object for invoices export. +Returns a batch job object for an invoices export. ```csharp ReadInvoicesExportAsync( string batchId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -334,6 +380,8 @@ ReadInvoicesExportAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage @@ -359,13 +407,17 @@ catch (ApiException e) # Read Subscriptions Export -This API returns a batchjob object for subscriptions export. +Returns a batch job object for a subscriptions export. ```csharp ReadSubscriptionsExportAsync( string batchId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -374,6 +426,8 @@ ReadSubscriptionsExportAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/batch-job-response.md) ## Example Usage diff --git a/doc/controllers/billing-portal.md b/doc/controllers/billing-portal.md index 6b8b88c0..3c1a8092 100644 --- a/doc/controllers/billing-portal.md +++ b/doc/controllers/billing-portal.md @@ -18,11 +18,13 @@ BillingPortalController billingPortalController = client.BillingPortalController # Enable Billing Portal for Customer +Enables Billing Portal access for a customer, with an option to send an invitation email at the same time. + ## Billing Portal Documentation Full documentation on how the Billing Portal operates within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24252412965133-Billing-Portal-Overview). -This documentation is focused on how the to configure the Billing Portal Settings, as well as Subscriber Interaction and Merchant Management of the Billing Portal. +This documentation is focused on how to configure the Billing Portal Settings, as well as Subscriber Interaction and Merchant Management of the Billing Portal. You can use this endpoint to enable Billing Portal access for a Customer, with the option of sending the Customer an Invitation email at the same time. @@ -40,6 +42,10 @@ EnableBillingPortalForCustomerAsync( Models.AutoInvite? autoInvite = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -49,6 +55,8 @@ EnableBillingPortalForCustomerAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-response.md) ## Example Usage @@ -78,7 +86,7 @@ catch (ApiException e) # Read Billing Portal Link -This method will provide to the API user the exact URL required for a subscriber to access the Billing Portal. +Returns the exact URL required for a subscriber to access the Billing Portal. ## Rules for Management Link API @@ -93,6 +101,10 @@ ReadBillingPortalLinkAsync( int customerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -101,6 +113,8 @@ ReadBillingPortalLinkAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/portal-management-link.md) ## Example Usage @@ -148,15 +162,13 @@ catch (ApiException e) # Resend Billing Portal Invitation -You can resend a customer's Billing Portal invitation. +Resends a customer's Billing Portal invitation. -If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with `error` message in the body. +If you attempt to resend an invitation 5 times within 30 minutes, you will receive a `422` response with an `error` message in the body. If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. -If you attempt to resend an invitation when the Billing Portal is already disabled for a Customer, you will receive a `422` error response. - -If you attempt to resend an invitation when the Customer does not exist a Customer, you will receive a `404` error response. +If you attempt to resend an invitation when the Customer does not exist, you will receive a `404` error response. ## Limitations @@ -167,6 +179,10 @@ ResendBillingPortalInvitationAsync( int customerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -175,6 +191,8 @@ ResendBillingPortalInvitationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/resent-invitation.md) ## Example Usage @@ -216,7 +234,7 @@ catch (ApiException e) # Revoke Billing Portal Access -You can revoke a customer's Billing Portal invitation. +Revokes a customer's Billing Portal invitation. If you attempt to revoke an invitation when the Billing Portal is already disabled for a Customer, you will receive a 422 error response. @@ -229,6 +247,10 @@ RevokeBillingPortalAccessAsync( int customerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -237,6 +259,8 @@ RevokeBillingPortalAccessAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/revoked-invitation.md) ## Example Usage diff --git a/doc/controllers/component-price-points.md b/doc/controllers/component-price-points.md index cfb66384..d5548b99 100644 --- a/doc/controllers/component-price-points.md +++ b/doc/controllers/component-price-points.md @@ -38,6 +38,10 @@ PromoteComponentPricePointToDefaultAsync( int pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -47,6 +51,8 @@ PromoteComponentPricePointToDefaultAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -111,6 +117,10 @@ CreateComponentPricePointAsync( Models.CreateComponentPricePointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -120,6 +130,8 @@ CreateComponentPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-point-response.md) ## Example Usage @@ -180,7 +192,7 @@ catch (ApiException e) # List Component Price Points -Use this endpoint to read current price points that are associated with a component. +Lists the price points associated with a component. You may specify the component by using either the numeric id or the `handle:gold` syntax. @@ -193,6 +205,10 @@ ListComponentPricePointsAsync( Models.ListComponentPricePointsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -201,6 +217,8 @@ ListComponentPricePointsAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-price-points-response.md) ## Example Usage @@ -276,7 +294,7 @@ catch (ApiException e) # Bulk Create Component Price Points -Use this endpoint to create multiple component price points in one request. +Creates multiple component price points in one request. ```csharp BulkCreateComponentPricePointsAsync( @@ -284,6 +302,10 @@ BulkCreateComponentPricePointsAsync( Models.CreateComponentPricePointsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -293,6 +315,8 @@ BulkCreateComponentPricePointsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-points-response.md) ## Example Usage @@ -446,6 +470,10 @@ CloneComponentPricePointAsync( Models.CloneComponentPricePointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -456,6 +484,8 @@ CloneComponentPricePointAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-price-point-currency-overage-response.md) ## Example Usage @@ -573,7 +603,7 @@ catch (ApiException e) # Update Component Price Point -When updating a price point, prices can be updated as well by creating new prices or editing / removing existing ones. +Updates a component price point and its associated prices. Passing in a price bracket without an `id` will attempt to create a new price. @@ -588,6 +618,10 @@ UpdateComponentPricePointAsync( Models.UpdateComponentPricePointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -598,6 +632,8 @@ UpdateComponentPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-point-response.md) ## Example Usage @@ -661,7 +697,7 @@ catch (ApiException e) # Read Component Price Point -Use this endpoint to retrieve details for a specific component price point. You can achieve this by using either the component price point ID or handle. +Returns details for a specific component price point. You can achieve this by using either the component price point ID or handle. ```csharp ReadComponentPricePointAsync( @@ -670,6 +706,10 @@ ReadComponentPricePointAsync( bool? currencyPrices = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -680,6 +720,8 @@ ReadComponentPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-point-currency-overage-response.md) ## Example Usage @@ -705,7 +747,7 @@ catch (ApiException e) # Archive Component Price Point -A price point can be archived at any time. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. +Archives a component price point. Subscriptions using a price point that has been archived will continue using it until they're moved to another price point. ```csharp ArchiveComponentPricePointAsync( @@ -713,6 +755,10 @@ ArchiveComponentPricePointAsync( ArchiveComponentPricePointPricePointId pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -722,6 +768,8 @@ ArchiveComponentPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-point-response.md) ## Example Usage @@ -791,7 +839,7 @@ catch (ApiException e) # Unarchive Component Price Point -Use this endpoint to unarchive a component price point. +Unarchives a component price point. ```csharp UnarchiveComponentPricePointAsync( @@ -799,6 +847,10 @@ UnarchiveComponentPricePointAsync( int pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -808,6 +860,8 @@ UnarchiveComponentPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-price-point-response.md) ## Example Usage @@ -865,7 +919,7 @@ catch (ApiException e) # Create Currency Prices -This endpoint allows you to create currency prices for a given currency that has been defined on the site level in your settings. +Creates currency prices for a given currency defined at the site level. When creating currency prices, they need to mirror the structure of your primary pricing. For each price level defined on the component price point, there should be a matching price level created in the given currency. @@ -877,6 +931,10 @@ CreateCurrencyPricesAsync( Models.CreateCurrencyPricesRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -886,6 +944,8 @@ CreateCurrencyPricesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-currency-prices-response.md) ## Example Usage @@ -954,7 +1014,7 @@ catch (ApiException e) # Update Currency Prices -This endpoint allows you to update currency prices for a given currency that has been defined on the site level in your settings. +Updates currency prices for a given currency defined at the site level. Note: Currency Prices are not able to be updated for custom price points. @@ -964,6 +1024,10 @@ UpdateCurrencyPricesAsync( Models.UpdateCurrencyPricesRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -973,6 +1037,8 @@ UpdateCurrencyPricesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-currency-prices-response.md) ## Example Usage @@ -1039,13 +1105,17 @@ catch (ApiException e) # List All Component Price Points -This method allows to retrieve a list of Components Price Points belonging to a Site. +Lists all component price points belonging to a site. ```csharp ListAllComponentPricePointsAsync( Models.ListAllComponentPricePointsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1054,6 +1124,8 @@ ListAllComponentPricePointsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-components-price-points-response.md) ## Example Usage diff --git a/doc/controllers/components.md b/doc/controllers/components.md index 8efe9d50..62ed6014 100644 --- a/doc/controllers/components.md +++ b/doc/controllers/components.md @@ -12,7 +12,7 @@ ComponentsController componentsController = client.ComponentsController; * [Create Metered Component](../../doc/controllers/components.md#create-metered-component) * [Create Quantity Based Component](../../doc/controllers/components.md#create-quantity-based-component) -* [Create on Off Component](../../doc/controllers/components.md#create-on-off-component) +* [Create On Off Component](../../doc/controllers/components.md#create-on-off-component) * [Create Prepaid Usage Component](../../doc/controllers/components.md#create-prepaid-usage-component) * [Create Event Based Component](../../doc/controllers/components.md#create-event-based-component) * [Find Component](../../doc/controllers/components.md#find-component) @@ -26,9 +26,9 @@ ComponentsController componentsController = client.ComponentsController; # Create Metered Component -This request will create a component definition of kind **metered_component** under the specified product family. Metered component can then be added and “allocated” for a subscription. +Creates a metered component definition under the specified product family. A metered component can then be added and “allocated” for a subscription. -Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Adwords clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. +Metered components are used to bill for any type of unit that resets to 0 at the end of the billing period (think daily Google Ads clicks or monthly cell phone minutes). This is most commonly associated with usage-based billing and many other pricing schemes. Note that this is different from recurring quantity-based components, which DO NOT reset to zero at the start of every billing period. If you want to bill for a quantity of something that does not change unless you change it, then you want quantity components, instead. @@ -40,6 +40,10 @@ CreateMeteredComponentAsync( Models.CreateMeteredComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -49,6 +53,8 @@ CreateMeteredComponentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -151,9 +157,9 @@ catch (ApiException e) # Create Quantity Based Component -This request will create a component definition of kind **quantity_based_component** under the specified product family. Quantity Based component can then be added and “allocated” for a subscription. +Creates a Quantity Based component definition under the specified product family. A Quantity Based component can then be added and “allocated” for a subscription. -When defining Quantity Based component, You can choose one of 2 types: +When defining a Quantity Based component, you can choose one of 2 types: #### Recurring @@ -173,6 +179,10 @@ CreateQuantityBasedComponentAsync( Models.CreateQuantityBasedComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -182,6 +192,8 @@ CreateQuantityBasedComponentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -282,9 +294,9 @@ catch (ApiException e) | 422 | Unprocessable Entity (WebDAV) | [`ErrorListResponseException`](../../doc/models/error-list-response-exception.md) | -# Create on Off Component +# Create On Off Component -This request will create a component definition of kind **on_off_component** under the specified product family. On/Off component can then be added and “allocated” for a subscription. +Creates an On/Off component definition under the specified product family. An On/Off component can then be added and “allocated” for a subscription. On/off components are used for any flat fee, recurring add on (think $99/month for tech support or a flat add on shipping fee). @@ -296,6 +308,10 @@ CreateOnOffComponentAsync( Models.CreateOnOffComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -305,6 +321,8 @@ CreateOnOffComponentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -392,7 +410,7 @@ catch (ApiException e) # Create Prepaid Usage Component -This request will create a component definition of kind **prepaid_usage_component** under the specified product family. Prepaid component can then be added and “allocated” for a subscription. +Creates a prepaid usage component definition under the specified product family. A prepaid component can then be added and “allocated” for a subscription. Prepaid components allow customers to pre-purchase units that can be used up over time on their subscription. In a sense, they are the mirror image of metered components; while metered components charge at the end of the period for the amount of units used, prepaid components are charged for at the time of purchase, and we subsequently keep track of the usage against the amount purchased. @@ -404,6 +422,10 @@ CreatePrepaidUsageComponentAsync( Models.CreatePrepaidComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -413,6 +435,8 @@ CreatePrepaidUsageComponentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -541,7 +565,7 @@ catch (ApiException e) # Create Event Based Component -This request will create a component definition of kind **event_based_component** under the specified product family. Event-based component can then be added and “allocated” for a subscription. +Creates an event-based component definition under the specified product family. An event-based component can then be added and “allocated” for a subscription. Event-based components are similar to other component types, in that you define the component parameters (such as name and taxability) and the pricing. A key difference for the event-based component is that it must be attached to a metric. This is because the metric provides the component with the actual quantity used in computing what and how much will be billed each period for each subscription. @@ -555,6 +579,10 @@ CreateEventBasedComponentAsync( Models.CreateEBBComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -564,6 +592,8 @@ CreateEventBasedComponentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -658,13 +688,17 @@ catch (ApiException e) # Find Component -This request will return information regarding a component having the handle you provide. You can identify your components with a handle so you don't have to save or reference the IDs we generate. +Returns information for a component matching the provided handle. You can identify your components with a handle so you don't have to save or reference the IDs we generate. ```csharp FindComponentAsync( string handle) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -673,6 +707,8 @@ FindComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -732,6 +768,10 @@ ReadComponentAsync( string componentId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -741,6 +781,8 @@ ReadComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -795,7 +837,7 @@ catch (ApiException e) # Update Product Family Component -This request will update a component from a specific product family. +Updates a component from a specific product family. You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. @@ -806,6 +848,10 @@ UpdateProductFamilyComponentAsync( Models.UpdateComponentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -816,6 +862,8 @@ UpdateProductFamilyComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -888,7 +936,7 @@ catch (ApiException e) # Archive Component -Sending a DELETE request to this endpoint will archive the component. All current subscribers will be unffected; their subscription/purchase will continue to be charged as usual. +Archives the component; all current subscribers will continue to be charged as usual. ```csharp ArchiveComponentAsync( @@ -896,6 +944,10 @@ ArchiveComponentAsync( string componentId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -905,6 +957,8 @@ ArchiveComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component.md) ## Example Usage @@ -964,13 +1018,17 @@ catch (ApiException e) # List Components -This request will return a list of components for a site. +Lists components for a site. ```csharp ListComponentsAsync( Models.ListComponentsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -979,6 +1037,8 @@ ListComponentsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/component-response.md) ## Example Usage @@ -1112,7 +1172,7 @@ catch (ApiException e) # Update Component -This request will update a component. +Updates a component. You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. @@ -1122,6 +1182,10 @@ UpdateComponentAsync( Models.UpdateComponentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1131,6 +1195,8 @@ UpdateComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/component-response.md) ## Example Usage @@ -1201,13 +1267,17 @@ catch (ApiException e) # List Components for Product Family -This request will return a list of components for a particular product family. +Lists components for a particular product family. ```csharp ListComponentsForProductFamilyAsync( Models.ListComponentsForProductFamilyInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1216,6 +1286,8 @@ ListComponentsForProductFamilyAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/component-response.md) ## Example Usage diff --git a/doc/controllers/coupons.md b/doc/controllers/coupons.md index 89114048..2dd34217 100644 --- a/doc/controllers/coupons.md +++ b/doc/controllers/coupons.md @@ -28,27 +28,26 @@ CouponsController couponsController = client.CouponsController; # Create Coupon -## Coupons Documentation - -Coupons can be administered in the Advanced Billing application or created via API. View our section on [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating-Editing-Deleting-Coupons) for more information. - -Additionally, for documentation on how to apply a coupon to a subscription within the Advanced Billing UI, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions). - -## Create Coupon - -This request will create a coupon, based on the provided information. - -You can create either a flat amount coupon, by specyfing `amount_in_cents`, or percentage coupon by specyfing `percentage`. +Creates a coupon under the specified product family. +You can create either a flat amount coupon by specifying amount_in_cents, or a percentage coupon by specifying percentage You can restrict a coupon to only apply to specific products / components by optionally passing in `restricted_products` and/or `restricted_components` objects in the format: `{ "": boolean_value }` +Coupons can be administered in the Advanced Billing application or created via API. See [creating coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creating-Editing-Deleting-Coupons) for more information. + +See [Apply Coupons to Subscriptions](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions) for information on applying a coupon to a subscription in the Advanced Billing UI. + ```csharp CreateCouponAsync( int productFamilyId, Models.CouponRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -58,6 +57,8 @@ CreateCouponAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -118,13 +119,17 @@ catch (ApiException e) # List Coupons for Product Family -List coupons for a specific Product Family in a Site. +Lists coupons for a specific product family in a site. ```csharp ListCouponsForProductFamilyAsync( Models.ListCouponsForProductFamilyInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -133,6 +138,8 @@ ListCouponsForProductFamilyAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/coupon-response.md) ## Example Usage @@ -272,7 +279,7 @@ catch (ApiException e) # Find Coupon -You can search for a coupon via the API with the find method. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If no coupon is found, a 404 is returned. +Searches for a coupon by code, returning a 404 if no coupon is found. By passing a code parameter, the find will attempt to locate a coupon that matches that code. If you have more than one product family and if the coupon you are trying to find does not belong to the default product family in your site, then you will need to specify (either in the url or as a query string param) the product family id. @@ -283,6 +290,10 @@ FindCouponAsync( bool? currencyPrices = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -293,6 +304,8 @@ FindCouponAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -316,7 +329,7 @@ catch (ApiException e) # Read Coupon -You can retrieve the Coupon via the API with the Show method. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. +Returns a coupon by its Advanced Billing-assigned ID. You must identify the Coupon in this call by the ID parameter that Advanced Billing assigns. If instead you would like to find a Coupon using a Coupon code, see the Coupon Find method. When fetching a coupon, 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. @@ -330,6 +343,10 @@ ReadCouponAsync( bool? currencyPrices = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -340,6 +357,8 @@ ReadCouponAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -394,9 +413,7 @@ catch (ApiException e) # Update Coupon -## Update Coupon - -You can update a Coupon via the API with a PUT request to the resource endpoint. +Updates a coupon. You can restrict a coupon to only apply to specific products / components by optionally passing in hashes of `restricted_products` and/or `restricted_components` in the format: `{ "": boolean_value }` @@ -408,6 +425,10 @@ UpdateCouponAsync( Models.CouponRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -418,6 +439,8 @@ UpdateCouponAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -507,7 +530,7 @@ catch (ApiException e) # Archive Coupon -You can archive a Coupon via the API with the archive method. +Archives a coupon, making it unavailable for future use while remaining active on existing subscriptions. Archiving makes that Coupon unavailable for future use, but allows it to remain attached and functional on existing Subscriptions that are using it. The `archived_at` date and time will be assigned. @@ -517,6 +540,10 @@ ArchiveCouponAsync( int couponId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -526,6 +553,8 @@ ArchiveCouponAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -578,13 +607,17 @@ catch (ApiException e) # List Coupons -You can retrieve a list of coupons. +Lists coupons for a site. ```csharp ListCouponsAsync( Models.ListCouponsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -593,6 +626,8 @@ ListCouponsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/coupon-response.md) ## Example Usage @@ -688,7 +723,7 @@ catch (ApiException e) # Read Coupon Usage -This request will provide details about the coupon usage as an array of data hashes, one per product. +Lists coupon usage details, one entry per product. ```csharp ReadCouponUsageAsync( @@ -696,6 +731,10 @@ ReadCouponUsageAsync( int couponId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -705,6 +744,8 @@ ReadCouponUsageAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/coupon-usage.md) ## Example Usage @@ -762,7 +803,7 @@ catch (ApiException e) # Validate Coupon -You can verify if a specific coupon code is valid using the `validate` method. This method is useful for validating coupon codes that are entered by a customer. If the coupon is found and is valid, the coupon will be returned with a 200 status code. +Verifies whether a specific coupon code is valid. This method is useful for validating coupon codes that are entered by a customer. If the coupon is found and is valid, the coupon will be returned with a 200 status code. If the coupon is invalid, the status code will be 404 and the response will say why it is invalid. If the coupon is valid, the status code will be 200 and the coupon will be returned. The following reasons for invalidity are supported: @@ -790,6 +831,10 @@ ValidateCouponAsync( int? productFamilyId = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -799,6 +844,8 @@ ValidateCouponAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-response.md) ## Example Usage @@ -857,7 +904,7 @@ catch (ApiException e) # Create or Update Coupon Currency Prices -This endpoint allows you to create and/or update currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. +Creates and/or updates currency prices for an existing coupon. Multiple prices can be created or updated in a single request but each of the currencies must be defined on the site level already and the coupon must be an amount-based coupon, not percentage. Currency pricing for coupons must mirror the setup of the primary coupon pricing - if the primary coupon is percentage based, you will not be able to define pricing in non-primary currencies. @@ -867,6 +914,10 @@ CreateOrUpdateCouponCurrencyPricesAsync( Models.CouponCurrencyRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -876,6 +927,8 @@ CreateOrUpdateCouponCurrencyPricesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-currency-response.md) ## Example Usage @@ -925,6 +978,8 @@ catch (ApiException e) # Create Coupon Subcodes +Creates subcodes for an existing coupon. + ## Coupon Subcodes Intro Coupon Subcodes allow you to create a set of unique codes that allow you to expand the use of one coupon. @@ -972,6 +1027,10 @@ CreateCouponSubcodesAsync( Models.CouponSubcodes body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -981,6 +1040,8 @@ CreateCouponSubcodesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-subcodes-response.md) ## Example Usage @@ -1025,13 +1086,17 @@ catch (ApiException e) # List Coupon Subcodes -This request allows you to request the subcodes that are attached to a coupon. +Lists the subcodes attached to a coupon. ```csharp ListCouponSubcodesAsync( Models.ListCouponSubcodesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1040,6 +1105,8 @@ ListCouponSubcodesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-subcodes.md) ## Example Usage @@ -1094,7 +1161,7 @@ catch (ApiException e) # Update Coupon Subcodes -You can update the subcodes for the given Coupon via the API with a PUT request to the resource endpoint. +Updates the subcodes for a coupon, replacing all existing subcodes with the new list. Send an array of new coupon subcodes. **Note**: All current subcodes for that Coupon will be deleted first, and replaced with the list of subcodes sent to this endpoint. @@ -1112,6 +1179,10 @@ UpdateCouponSubcodesAsync( Models.CouponSubcodes body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1121,6 +1192,8 @@ UpdateCouponSubcodesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/coupon-subcodes-response.md) ## Example Usage @@ -1153,6 +1226,8 @@ catch (ApiException e) # Delete Coupon Subcode +Deletes a specific subcode from a coupon. + ## Example Given a coupon with an ID of 567, and a coupon subcode of 20OFF, the URL to `DELETE` this coupon subcode would be: @@ -1182,6 +1257,10 @@ DeleteCouponSubcodeAsync( string subcode) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1191,6 +1270,8 @@ DeleteCouponSubcodeAsync( ## Response Type +**200**: OK + `Task` ## Example Usage diff --git a/doc/controllers/custom-fields.md b/doc/controllers/custom-fields.md index ab9d47c3..725f2738 100644 --- a/doc/controllers/custom-fields.md +++ b/doc/controllers/custom-fields.md @@ -44,6 +44,10 @@ CreateMetafieldsAsync( Models.CreateMetafieldsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -53,6 +57,8 @@ CreateMetafieldsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/metafield.md) ## Example Usage @@ -146,6 +152,10 @@ ListMetafieldsAsync( Models.ListMetafieldsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -154,6 +164,8 @@ ListMetafieldsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-metafields-response.md) ## Example Usage @@ -227,7 +239,7 @@ With this endpoint, you can: - Add new metadata to a dropdown or radio for a metafield that was created without metadata. -- Remove metadata for a dropdown or radio for a metafield. +- Remove metadata for a dropdown or radio for a metafield. > Note: Updates to metadata overwrite existing values. To remove one or more values, specify all metadata values except those you want to remove. @@ -241,6 +253,10 @@ UpdateMetafieldAsync( Models.UpdateMetafieldsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -250,6 +266,8 @@ UpdateMetafieldAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/metafield.md) ## Example Usage @@ -287,6 +305,10 @@ DeleteMetafieldAsync( string name = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -296,6 +318,8 @@ DeleteMetafieldAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -334,6 +358,10 @@ CreateMetadataAsync( Models.CreateMetadataRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -344,6 +372,8 @@ CreateMetadataAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/metadata.md) ## Example Usage @@ -402,6 +432,10 @@ ListMetadataAsync( Models.ListMetadataInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -410,6 +444,8 @@ ListMetadataAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/paginated-metadata.md) ## Example Usage @@ -461,7 +497,7 @@ Updates metadata and metafields on the Site and the customer or subscription spe If you update metadata on a subscription or customer with a metafield that does not already exist, the metafield is created with the metadata you specify and it is always added as a text field to the Site and to the subscription or customer you specify. You can update the input_type for the metafield with the Update Metafield endpoint. -Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for Subscription and another 100 for Customer. +Each site is limited to 100 unique metafields per resource. This means you can have 100 metafields for the Subscription resource and another 100 for the Customer resource. ```csharp UpdateMetadataAsync( @@ -470,6 +506,10 @@ UpdateMetadataAsync( Models.UpdateMetadataRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -480,6 +520,8 @@ UpdateMetadataAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/metadata.md) ## Example Usage @@ -523,6 +565,10 @@ DeleteMetadataAsync( List names = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -534,6 +580,8 @@ DeleteMetadataAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -563,13 +611,17 @@ catch (ApiException e) # List Metadata for Resource Type -Lists metadata for a specified array of subscriptions or customers. +Lists metadata for a specified array of subscriptions or customers. ```csharp ListMetadataForResourceTypeAsync( Models.ListMetadataForResourceTypeInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -578,6 +630,8 @@ ListMetadataForResourceTypeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/paginated-metadata.md) ## Example Usage diff --git a/doc/controllers/customers.md b/doc/controllers/customers.md index 695d23b3..4db4a875 100644 --- a/doc/controllers/customers.md +++ b/doc/controllers/customers.md @@ -21,7 +21,7 @@ CustomersController customersController = client.CustomersController; # Create Customer -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. +Creates a new customer; can also be created alongside a new 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 Advanced Billing’s unique ID for the customer, which is in the `id` attribute. @@ -51,6 +51,10 @@ CreateCustomerAsync( Models.CreateCustomerRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -59,6 +63,8 @@ CreateCustomerAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-response.md) ## Example Usage @@ -143,7 +149,7 @@ catch (ApiException e) # List Customers -This request will by default list all customers associated with your Site. +Lists all customers associated with your site, or filters results using the search parameter. ## Find Customer @@ -164,6 +170,10 @@ ListCustomersAsync( Models.ListCustomersInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -172,6 +182,8 @@ ListCustomersAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/customer-response.md) ## Example Usage @@ -288,6 +300,10 @@ ReadCustomerAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -296,6 +312,8 @@ ReadCustomerAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-response.md) ## Example Usage @@ -352,7 +370,7 @@ catch (ApiException e) # Update Customer -This method allows to update the Customer. +Updates the customer. ```csharp UpdateCustomerAsync( @@ -360,6 +378,10 @@ UpdateCustomerAsync( Models.UpdateCustomerRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -369,6 +391,8 @@ UpdateCustomerAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-response.md) ## Example Usage @@ -443,13 +467,17 @@ catch (ApiException e) # Delete Customer -This method allows you to delete the Customer. +Deletes the customer. ```csharp DeleteCustomerAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -458,6 +486,8 @@ DeleteCustomerAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -477,13 +507,17 @@ catch (ApiException e) # Read Customer by Reference -Use this method to return the customer object if you have the unique **Reference ID (Your App)** value handy. It will return a single match. +Returns a customer by their unique reference ID. It will return a single match. ```csharp ReadCustomerByReferenceAsync( string reference) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -492,6 +526,8 @@ ReadCustomerByReferenceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-response.md) ## Example Usage @@ -511,13 +547,17 @@ catch (ApiException e) # List Customer Subscriptions -This method lists all subscriptions that belong to a customer. +Lists all subscriptions that belong to a customer. ```csharp ListCustomerSubscriptionsAsync( int customerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -526,6 +566,8 @@ ListCustomerSubscriptionsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/subscription-response.md) ## Example Usage diff --git a/doc/controllers/events-based-billing-segments.md b/doc/controllers/events-based-billing-segments.md index 3d4eddba..8c5ffb5f 100644 --- a/doc/controllers/events-based-billing-segments.md +++ b/doc/controllers/events-based-billing-segments.md @@ -20,7 +20,7 @@ EventsBasedBillingSegmentsController eventsBasedBillingSegmentsController = clie # Create Segment -This endpoint creates a new Segment for a Component with segmented Metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. +Creates a new segment for a component with a segmented metric. It allows you to specify properties to bill upon and prices for each Segment. You can only pass as many "property_values" as the related Metric has segmenting properties defined. You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. @@ -31,6 +31,10 @@ CreateSegmentAsync( Models.CreateSegmentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -41,6 +45,8 @@ CreateSegmentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/segment-response.md) ## Example Usage @@ -100,7 +106,7 @@ catch (ApiException e) # List Segments for Price Point -This endpoint allows you to fetch Segments created for a given Price Point. They will be returned in the order of creation. +Lists segments created for a given price point, in order of creation. You can pass `page` and `per_page` parameters in order to access all of the segments. By default it will return `30` records. You can set `per_page` to `200` at most. @@ -111,6 +117,10 @@ ListSegmentsForPricePointAsync( Models.ListSegmentsForPricePointInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -119,6 +129,8 @@ ListSegmentsForPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-segments-response.md) ## Example Usage @@ -160,7 +172,7 @@ catch (ApiException e) # Update Segment -This endpoint updates a single Segment for a Component with a segmented Metric. It allows you to update the pricing for the segment. +Updates a single segment for a component with a segmented metric. It allows you to update the pricing for the segment. You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. @@ -172,6 +184,10 @@ UpdateSegmentAsync( Models.UpdateSegmentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -183,6 +199,8 @@ UpdateSegmentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/segment-response.md) ## Example Usage @@ -219,7 +237,7 @@ catch (ApiException e) # Delete Segment -This endpoint allows you to delete a Segment with specified ID. +Deletes a segment with the specified ID. You may specify component and/or price point by using either the numeric ID or the `handle:gold` syntax. @@ -230,6 +248,10 @@ DeleteSegmentAsync( double id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -240,6 +262,8 @@ DeleteSegmentAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -272,7 +296,7 @@ catch (ApiException e) # Bulk Create Segments -This endpoint allows you to create multiple segments in one request. The array of segments can contain up to `2000` records. +Creates multiple segments in one request. The array of segments can contain up to `2000` records. If any of the records contain an error the whole request would fail and none of the requested segments get created. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. @@ -285,6 +309,10 @@ BulkCreateSegmentsAsync( Models.BulkCreateSegments body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -295,6 +323,8 @@ BulkCreateSegmentsAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/list-segments-response.md) ## Example Usage @@ -329,7 +359,7 @@ catch (ApiException e) # Bulk Update Segments -This endpoint allows you to update multiple segments in one request. The array of segments can contain up to `1000` records. +Updates multiple segments in one request. The array of segments can contain up to `1000` records. If any of the records contain an error the whole request would fail and none of the requested segments get updated. The error response contains a message for only the one segment that failed validation, with the corresponding index in the array. @@ -342,6 +372,10 @@ BulkUpdateSegmentsAsync( Models.BulkUpdateSegments body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -352,6 +386,8 @@ BulkUpdateSegmentsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-segments-response.md) ## Example Usage diff --git a/doc/controllers/events.md b/doc/controllers/events.md index 1475ee3b..49744c25 100644 --- a/doc/controllers/events.md +++ b/doc/controllers/events.md @@ -17,11 +17,13 @@ EventsController eventsController = client.EventsController; # List Events +Lists events for a site. + ## Events Intro Advanced Billing Events include various activity that happens around a Site. This information is **especially** useful to track down issues that arise when subscriptions are not created due to errors. -Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to record view Events / Site Activty in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). +Within the Advanced Billing UI, "Events" are referred to as "Site Activity". Full documentation on how to view Events / Site Activity in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24250671733517-Site-Activity). ## List Events for a Site @@ -91,6 +93,10 @@ ListEventsAsync( Models.ListEventsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -99,6 +105,8 @@ ListEventsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/event-response.md) ## Example Usage @@ -192,7 +200,7 @@ catch (ApiException e) # List Subscription Events -The following request will return a list of events for a subscription. +Lists events for a subscription. ## Event Key @@ -209,6 +217,10 @@ ListSubscriptionEventsAsync( Models.ListSubscriptionEventsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -217,6 +229,8 @@ ListSubscriptionEventsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/event-response.md) ## Example Usage @@ -291,13 +305,17 @@ catch (ApiException e) # Read Events Count -Get a count of all the events for a given site by using this method. +Returns the total count of events for a given site. ```csharp ReadEventsCountAsync( Models.ReadEventsCountInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -306,6 +324,8 @@ ReadEventsCountAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/count-response.md) ## Example Usage diff --git a/doc/controllers/insights.md b/doc/controllers/insights.md index 926955db..0a40dce1 100644 --- a/doc/controllers/insights.md +++ b/doc/controllers/insights.md @@ -13,12 +13,12 @@ InsightsController insightsController = client.InsightsController; * [Read Site Stats](../../doc/controllers/insights.md#read-site-stats) * [Read Mrr](../../doc/controllers/insights.md#read-mrr) * [List Mrr Movements](../../doc/controllers/insights.md#list-mrr-movements) -* [List Mrr Per Subscription](../../doc/controllers/insights.md#list-mrr-per-subscription) +* [List Mrr per Subscription](../../doc/controllers/insights.md#list-mrr-per-subscription) # Read Site Stats -The Stats API is a very basic view of some Site-level stats. This API call only answers with JSON responses. An XML version is not provided. +Returns basic site-level stats. This API call only answers with JSON responses. An XML version is not provided. ## Stats Documentation @@ -32,8 +32,14 @@ https://subdomain.chargify.com/dashboard ReadSiteStatsAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**200**: OK + [`Task`](../../doc/models/site-summary.md) ## Example Usage @@ -73,7 +79,7 @@ catch (ApiException e) **This endpoint is deprecated.** -This endpoint returns your site's current MRR, including plan and usage breakouts. +Returns your site's current MRR, including plan and usage breakouts. ```csharp ReadMrrAsync( @@ -81,6 +87,10 @@ ReadMrrAsync( int? subscriptionId = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -90,6 +100,8 @@ ReadMrrAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/mrr-response.md) ## Example Usage @@ -130,7 +142,7 @@ catch (ApiException e) **This endpoint is deprecated.** -This endpoint returns your site's MRR movements. +Lists your site's MRR movements. ## Understanding MRR movements @@ -160,6 +172,10 @@ ListMrrMovementsAsync( Models.ListMrrMovementsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -168,6 +184,8 @@ ListMrrMovementsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-mrr-response.md) ## Example Usage @@ -242,7 +260,7 @@ catch (ApiException e) ``` -# List Mrr Per Subscription +# List Mrr per Subscription **This endpoint is deprecated.** @@ -253,6 +271,10 @@ ListMrrPerSubscriptionAsync( Models.ListMrrPerSubscriptionInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -261,6 +283,8 @@ ListMrrPerSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-mrr-response.md) ## Example Usage diff --git a/doc/controllers/invoices.md b/doc/controllers/invoices.md index 0c59ada7..5d70d814 100644 --- a/doc/controllers/invoices.md +++ b/doc/controllers/invoices.md @@ -37,7 +37,7 @@ Refund an invoice, segment, or consolidated invoice. A refund less than the total of a consolidated invoice will be split across its segments. -A $50.00 refund on a $100.00 consolidated invoice with one $60.00 and one $40.00 segment, the refunded amount will be applied as 50% of each ($30.00 and $20.00 respectively). +For a $50.00 refund on a $100.00 consolidated invoice with one $60.00 segment and one $40.00 segment, the refunded amount will be applied as 50% of each ($30.00 and $20.00, respectively). ```csharp RefundInvoiceAsync( @@ -45,6 +45,10 @@ RefundInvoiceAsync( Models.RefundInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -54,6 +58,8 @@ RefundInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -108,6 +114,10 @@ ListInvoicesAsync( Models.ListInvoicesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -116,6 +126,8 @@ ListInvoicesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-invoices-response.md) ## Example Usage @@ -459,6 +471,10 @@ ReadInvoiceAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -467,6 +483,8 @@ ReadInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -560,6 +578,7 @@ catch (ApiException e) "subtotal_amount": "100.0", "discount_amount": "0.0", "tax_amount": "0.0", + "tax_included": false, "total_amount": "100.0", "tiered_unit_price": false, "period_range_start": "2018-07-26", @@ -625,6 +644,10 @@ ListInvoiceEventsAsync( Models.ListInvoiceEventsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -633,6 +656,8 @@ ListInvoiceEventsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-invoice-events-response.md) ## Example Usage @@ -757,6 +782,7 @@ catch (ApiException e) "subtotal_amount": "99.0", "discount_amount": "9.9", "tax_amount": "6.01425", + "tax_included": false, "total_amount": "95.11425", "tiered_unit_price": false, "period_range_start": "2018-08-01", @@ -777,6 +803,7 @@ catch (ApiException e) "subtotal_amount": "15.5", "discount_amount": "1.55", "tax_amount": "0.941625", + "tax_included": false, "total_amount": "14.891625", "tiered_unit_price": true, "period_range_start": "2018-07-22", @@ -825,6 +852,7 @@ catch (ApiException e) "subtotal_amount": "47.0", "discount_amount": "4.7", "tax_amount": "2.85525", + "tax_included": false, "total_amount": "45.15525", "tiered_unit_price": true, "period_range_start": "2018-07-22", @@ -873,6 +901,7 @@ catch (ApiException e) "subtotal_amount": "14.0", "discount_amount": "1.4", "tax_amount": "0.8505", + "tax_included": false, "total_amount": "13.4505", "tiered_unit_price": false, "period_range_start": "2018-08-01", @@ -1048,6 +1077,10 @@ RecordPaymentForInvoiceAsync( Models.CreateInvoicePaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1057,6 +1090,8 @@ RecordPaymentForInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -1102,7 +1137,7 @@ catch (ApiException e) This API call should be used when you want to record an external payment against multiple invoices. -In order apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. +To apply a payment to multiple invoices, at minimum, specify the `amount` and `applications` (i.e., `invoice_uid` and `amount`) details. ``` { @@ -1132,6 +1167,10 @@ RecordPaymentForMultipleInvoicesAsync( Models.CreateMultiInvoicePaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1140,6 +1179,8 @@ RecordPaymentForMultipleInvoicesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/multi-invoice-payment-response.md) ## Example Usage @@ -1225,6 +1266,10 @@ ListCreditNotesAsync( Models.ListCreditNotesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1233,6 +1278,8 @@ ListCreditNotesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-credit-notes-response.md) ## Example Usage @@ -1328,6 +1375,7 @@ catch (ApiException e) "subtotal_amount": "1.971004", "discount_amount": "0.19862831", "tax_amount": "0.11963536", + "tax_included": false, "total_amount": "1.89201105", "tiered_unit_price": false, "period_range_start": "2018-11-30", @@ -1346,6 +1394,7 @@ catch (ApiException e) "subtotal_amount": "114.21127834", "discount_amount": "11.42112783", "tax_amount": "6.93833516", + "tax_included": false, "total_amount": "109.72848567", "tiered_unit_price": false, "period_range_start": "2018-12-30", @@ -1364,6 +1413,7 @@ catch (ApiException e) "subtotal_amount": "9.16746047", "discount_amount": "0.91674605", "tax_amount": "0.55692322", + "tax_included": false, "total_amount": "8.80763764", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1382,6 +1432,7 @@ catch (ApiException e) "subtotal_amount": "72.57572871", "discount_amount": "7.25757287", "tax_amount": "4.40897552", + "tax_included": false, "total_amount": "69.72713136", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1400,6 +1451,7 @@ catch (ApiException e) "subtotal_amount": "3.12839588", "discount_amount": "0.31322157", "tax_amount": "0.19002427", + "tax_included": false, "total_amount": "3.00519858", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1418,6 +1470,7 @@ catch (ApiException e) "subtotal_amount": "7.63955039", "discount_amount": "0.76395504", "tax_amount": "0.46410269", + "tax_included": false, "total_amount": "7.33969804", "tiered_unit_price": false, "period_range_start": "2018-12-30", @@ -1570,6 +1623,10 @@ ReadCreditNoteAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1578,6 +1635,8 @@ ReadCreditNoteAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/credit-note.md) ## Example Usage @@ -1661,6 +1720,7 @@ catch (ApiException e) "subtotal_amount": "1.971004", "discount_amount": "0.19862831", "tax_amount": "0.11963536", + "tax_included": false, "total_amount": "1.89201105", "tiered_unit_price": false, "period_range_start": "2018-11-30", @@ -1681,6 +1741,7 @@ catch (ApiException e) "subtotal_amount": "114.21127834", "discount_amount": "11.42112783", "tax_amount": "6.93833516", + "tax_included": false, "total_amount": "109.72848567", "tiered_unit_price": false, "period_range_start": "2018-12-30", @@ -1701,6 +1762,7 @@ catch (ApiException e) "subtotal_amount": "9.16746047", "discount_amount": "0.91674605", "tax_amount": "0.55692322", + "tax_included": false, "total_amount": "8.80763764", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1721,6 +1783,7 @@ catch (ApiException e) "subtotal_amount": "72.57572871", "discount_amount": "7.25757287", "tax_amount": "4.40897552", + "tax_included": false, "total_amount": "69.72713136", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1741,6 +1804,7 @@ catch (ApiException e) "subtotal_amount": "3.12839588", "discount_amount": "0.31322157", "tax_amount": "0.19002427", + "tax_included": false, "total_amount": "3.00519858", "tiered_unit_price": true, "period_range_start": "2018-11-30", @@ -1761,6 +1825,7 @@ catch (ApiException e) "subtotal_amount": "7.63955039", "discount_amount": "0.76395504", "tax_amount": "0.46410269", + "tax_included": false, "total_amount": "7.33969804", "tiered_unit_price": false, "period_range_start": "2018-12-30", @@ -1920,6 +1985,10 @@ RecordPaymentForSubscriptionAsync( Models.RecordPaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1929,6 +1998,8 @@ RecordPaymentForSubscriptionAsync( ## Response Type +**201**: OK + [`Task`](../../doc/models/record-payment-response.md) ## Example Usage @@ -2012,6 +2083,10 @@ ReopenInvoiceAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2020,6 +2095,8 @@ ReopenInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -2058,6 +2135,10 @@ VoidInvoiceAsync( Models.VoidInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2067,6 +2148,8 @@ VoidInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -2115,6 +2198,10 @@ ListConsolidatedInvoiceSegmentsAsync( Models.ListConsolidatedInvoiceSegmentsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2123,6 +2210,8 @@ ListConsolidatedInvoiceSegmentsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/consolidated-invoice.md) ## Example Usage @@ -2461,13 +2550,13 @@ Instead of creating custom products like in above example, You can pass existing The price for each line item will be calculated as well as a total due amount for the invoice. Multiple line items can be sent. -### Line items types +### Line item types -When defining line item, You can choose one of 3 types for one line item: +When defining a line item, You can choose one of 3 types for a line item: #### Custom item -Like in basic behavior example above, You can pass `title` and `unit_price` for custom item. +As shown in the basic behavior example, You can pass `title` and `unit_price` for custom item. #### Product id @@ -2475,7 +2564,7 @@ Product handle (with handle: prefix) or id from the scope of current subscriptio #### Component id -Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supportted only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. +Component handle (with handle: prefix) or id from the scope of current subscription's site can be provided with `component_id`. If `component_id` is used, following fields cannot be used: `title`, `product_id`. By default `unit_price` is taken from product's default price point, but can be overwritten by passing `unit_price` or `price_point_id`. At this moment price points are supported only for quantity based, on/off and metered components. For prepaid and event based billing components `unit_price` is required. ### Coupons @@ -2612,7 +2701,7 @@ Optional `description` parameter, it will overwrite default generated descriptio #### Issue Date -By default, invoices will be created with a issue date set to today. `issue_date` parameter can be send to alter that. Only dates in the past can be send. `issue_date` should be send in `YYYY-MM-DD` format. +By default, invoices will be created with a issue date set to today in your site's time zone. The `issue_date` parameter can be sent to alter the default. Only today or dates in the past are accepted. This date is interpreted and validated in your site's time zone. The format for `issue_date` is `YYYY-MM-DD`. #### Net Terms @@ -2624,7 +2713,7 @@ The seller, shipping and billing addresses can be sent to override the site's de #### Memo and Payment Instructions -A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instrucions` parameter. +A custom memo can be sent with the `memo` parameter to override the site's default. Likewise, custom payment instructions can be sent with the `payment_instructions` parameter. #### Status @@ -2636,6 +2725,10 @@ CreateInvoiceAsync( Models.CreateInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2645,6 +2738,8 @@ CreateInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice-response.md) ## Example Usage @@ -2765,6 +2860,7 @@ catch (ApiException e) "subtotal_amount": "1800.0", "discount_amount": "0.0", "tax_amount": "0.0", + "tax_included": false, "total_amount": "1800.0", "tiered_unit_price": false, "period_range_start": "2020-12-02", @@ -2804,6 +2900,10 @@ SendInvoiceAsync( Models.SendInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2813,6 +2913,8 @@ SendInvoiceAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -2861,7 +2963,7 @@ catch (ApiException e) # Preview Customer Information Changes -Customer information may change after an invoice is issued which may lead to a mismatch between customer information that are present on an open invoice and actual customer information. This endpoint allows to preview these differences, if any. +Customer information may change after an invoice is issued, which may lead to a mismatch between customer information that is present on an open invoice and actual customer information. This endpoint allows you to preview these differences, if any. The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. @@ -2870,6 +2972,10 @@ PreviewCustomerInformationChangesAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2878,6 +2984,8 @@ PreviewCustomerInformationChangesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/customer-changes-preview-response.md) ## Example Usage @@ -2961,7 +3069,7 @@ catch (ApiException e) # Update Customer Information -This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint before. +This endpoint updates customer information on an open invoice and returns the updated invoice. If you would like to preview changes that will be applied, use the `/invoices/{uid}/customer_information/preview.json` endpoint first. The endpoint doesn't accept a request body. Customer information differences are calculated on the application side. @@ -2970,6 +3078,10 @@ UpdateCustomerInformationAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -2978,6 +3090,8 @@ UpdateCustomerInformationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage @@ -3200,9 +3314,9 @@ This endpoint allows you to issue an invoice that is in "pending" or "draft" sta You cannot issue a pending child invoice that was created for a member subscription in a group. -For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on subscription will be automatically applied. Additionally, if setting is on, an email will be sent for issued invoice. +For Remittance subscriptions, the invoice will go into "open" status and payment won't be attempted. The value for `on_failed_payment` would be rejected if sent. Any prepayments or service credits that exist on the subscription will be automatically applied. Additionally, if the setting is enabled, an email will be sent for the issued invoice. -For Automatic subscriptions, prepayments and service credits will apply to the invoice and before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value: +For Automatic subscriptions, prepayments and service credits will apply to the invoice before payment is attempted. On successful payment, the invoice will go into "paid" status and email will be sent to the customer (if setting applies). When payment fails, the next event depends on the `on_failed_payment` value: - `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option. - `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history. @@ -3214,6 +3328,10 @@ IssueInvoiceAsync( Models.IssueInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -3223,6 +3341,8 @@ IssueInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/invoice.md) ## Example Usage diff --git a/doc/controllers/offers.md b/doc/controllers/offers.md index 6fe434ec..b037903a 100644 --- a/doc/controllers/offers.md +++ b/doc/controllers/offers.md @@ -19,7 +19,7 @@ OffersController offersController = client.OffersController; # Create Offer -Create an offer within your Advanced Billing site by sending a POST request. +Creates an offer within your Advanced Billing site. ## Documentation @@ -38,6 +38,10 @@ CreateOfferAsync( Models.CreateOfferRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -46,6 +50,8 @@ CreateOfferAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/offer-response.md) ## Example Usage @@ -140,13 +146,17 @@ catch (ApiException e) # List Offers -This endpoint will list offers for a site. +Lists offers for a site. ```csharp ListOffersAsync( Models.ListOffersInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -155,6 +165,8 @@ ListOffersAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-offers-response.md) ## Example Usage @@ -245,13 +257,17 @@ catch (ApiException e) # Read Offer -This method allows you to list a specific offer's attributes. This is different than list all offers for a site, as it requires an `offer_id`. +Returns a specific offer's attributes. This is different from listing all offers for a site, as it requires an `offer_id`. ```csharp ReadOfferAsync( int offerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -260,6 +276,8 @@ ReadOfferAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/offer-response.md) ## Example Usage @@ -279,13 +297,17 @@ catch (ApiException e) # Archive Offer -Archive an existing offer. Please provide an `offer_id` in order to archive the correct item. +Archives an existing offer. Please provide an `offer_id` in order to archive the correct item. ```csharp ArchiveOfferAsync( int offerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -294,6 +316,8 @@ ArchiveOfferAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -313,13 +337,17 @@ catch (ApiException e) # Unarchive Offer -Unarchive a previously archived offer. Please provide an `offer_id` in order to un-archive the correct item. +Unarchives a previously archived offer. Please provide an `offer_id` in order to unarchive the correct item. ```csharp UnarchiveOfferAsync( int offerId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -328,6 +356,8 @@ UnarchiveOfferAsync( ## Response Type +**200**: OK + `Task` ## Example Usage diff --git a/doc/controllers/payment-profiles.md b/doc/controllers/payment-profiles.md index a2448d21..d234337e 100644 --- a/doc/controllers/payment-profiles.md +++ b/doc/controllers/payment-profiles.md @@ -34,7 +34,7 @@ Select an option from the **Request Examples** drop-down on the right side of th Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. -Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. +Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Maxio.js (formerly Chargify.js)](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. See the following articles to learn more about subscriptions and payments: @@ -42,74 +42,33 @@ See the following articles to learn more about subscriptions and payments: + [Self Service Pages](https://maxio.zendesk.com/hc/en-us/articles/24261425318541-Self-Service-Pages) (Allows credit card updates by Subscriber) + [Public Signup Pages payment settings](https://maxio.zendesk.com/hc/en-us/articles/24261368332557-Individual-Page-Settings) + [Taxes](https://developers.chargify.com/docs/developer-docs/d2e9e34db740e-signups#taxes) -+ [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview) - + [Chargify.js with GoCardless - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQZKCER8CFK40MR6XJ) - + [Chargify.js with GoCardless - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QR09JVHWW0MCA7HVJV) - + [Chargify.js with Stripe Direct Debit - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQFKKN8Z7B7DZ9AJS5) - + [Chargify.js with Stripe Direct Debit - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QRECQQ4ECS3ZA55GY7) - + [Chargify.js with Stripe BECS Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway) - + [Chargify.js with Stripe BECS Direct Debit - full example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#full-example-with-sepa-direct-debit-stripe-gateway) ++ [Maxio.js (formerly Chargify.js)](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview) + + [Maxio.js with GoCardless - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQZKCER8CFK40MR6XJ) + + [Maxio.js with GoCardless - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QR09JVHWW0MCA7HVJV) + + [Maxio.js with Stripe Direct Debit - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQFKKN8Z7B7DZ9AJS5) + + [Maxio.js with Stripe Direct Debit - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QRECQQ4ECS3ZA55GY7) + + [Maxio.js with Stripe BECS Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway) + + [Maxio.js with Stripe BECS Direct Debit - full example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#full-example-with-sepa-direct-debit-stripe-gateway) + [Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoCardless) + [Full documentation on Stripe SEPA Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Full documentation on Stripe BECS Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) + [Full documentation on Stripe BACS Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit) -## 3D Secure Authentication during payment profile creation. +## 3D Secure (3DS) Authentication post-authentication flow -When a payment requires 3D Secure Authentication to adhear to Strong Customer Authentication (SCA) during payment profile creation, the request enters a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). In this case, a 422 Unprocessable Entity status is returned with the following response: +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. -```json -{ - "jsonapi": { - "version": "1.0" - }, - "errors": [ - { - "title": "This card requires 3DSecure verification.", - "detail": "This card requires 3D secure authentication. Redirect the customer to the URL from the action_link attribute to authenticate. Attach callback_url param to this URL if you want to be notified about the result of 3D Secure authentication. Attach redirect_url param to this URL if you want to redirect a customer back to your page after 3D Secure authentication. Example: https://checkout-test.chargifypay.test/3d-secure/checkout/pay_uerzhsxd5uhkbodx5jhvkg6yeu?one_time_token_id=93&callback_url=http://localhost:4000&redirect_url=https://yourpage.com will do a POST request to https://localhost:4000 after credit card is authenticated and will redirect a customer to https://yourpage.com after 3DS authentication.", - "links": { - "action_link": "https://checkout-test.chargifypay.test/3d-secure/checkout/pay_uerzhsxd5uhkbodx5jhvkg6yeu?one_time_token_id=93" - } - } - ] -} -``` - -To let the customer go through 3D Secure Authentication, they need to be redirected to the URL specified in `action_link`. - -Optionally, you can specify the `callback_url` parameter in the `action_link` URL to receive notification about the result of 3D Secure Authentication. - -The `callback_url` will return the following information: - -- whether the authentication was successful (`success`) -- the payment profile ID (`payment_profile_id`) - -You can also specify a `redirect_url` parameter in the `action_link` URL to redirect the customer back to your site. - -You cannot use action_link in an iframe inside a custom application. You must redirect the customer directly to the `action_link` and use the `redirect_url` or `callback_url` to be notified of the result. - -The final URL that you send a customer 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://checkout-test.chargifypay.test/3d-secure/checkout/pay_uerzhsxd5uhkbodx5jhvkg6yeu?one_time_token_id=93&callback_url=http://localhost:4000&redirect_url=https://yourpage.com` - -### Example Redirect Flow - -Here's an example flow to redirect customers to different pages depending on whether SCA was performed successfully: - -1. Create a payment profile via the API; it requires 3DS. -2. You receive an `action_link` in the response. -3. Use this `action_link` to, for example, connect with your internal resources or generate a `session_id`. -4. Include one 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 completes 3DS authentication, we notify you of the result via the applied `callback_url`. -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 if the redirect was successful. +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. ```csharp CreatePaymentProfileAsync( Models.CreatePaymentProfileRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -118,6 +77,8 @@ CreatePaymentProfileAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -185,13 +146,17 @@ catch (ApiException e) # List Payment Profiles -This method will return all of the active `payment_profiles` for a Site, or for one Customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. +Returns all active payment profiles for a site, or for one customer within a site. If no payment profiles are found, this endpoint will return an empty array, not a 404. ```csharp ListPaymentProfilesAsync( Models.ListPaymentProfilesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -200,6 +165,8 @@ ListPaymentProfilesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -287,7 +254,7 @@ catch (ApiException e) # Read Payment Profile -Using the GET method you can retrieve a Payment Profile identified by its unique ID. +Returns a payment profile identified by its unique ID. Note that a different JSON object will be returned if the card method on file is a bank account. @@ -330,6 +297,10 @@ ReadPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -338,6 +309,8 @@ ReadPaymentProfileAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -394,6 +367,8 @@ catch (ApiException e) # Update Payment Profile +Updates a payment profile. + ## 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. @@ -435,6 +410,10 @@ UpdatePaymentProfileAsync( Models.UpdatePaymentProfileRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -444,6 +423,8 @@ UpdatePaymentProfileAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -520,6 +501,10 @@ DeleteUnusedPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -528,6 +513,8 @@ DeleteUnusedPaymentProfileAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -570,6 +557,10 @@ DeleteSubscriptionsPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -579,6 +570,8 @@ DeleteSubscriptionsPaymentProfileAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -602,7 +595,7 @@ catch (ApiException e) # Verify Bank Account -Submit the two small deposit amounts the customer received in their bank account in order to verify the bank account. (Stripe only) +Verifies a bank account. Submit the two small deposit amounts the customer received in their bank account to verify the bank account. (Stripe only) ```csharp VerifyBankAccountAsync( @@ -610,6 +603,10 @@ VerifyBankAccountAsync( Models.BankAccountVerificationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -619,6 +616,8 @@ VerifyBankAccountAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/bank-account-response.md) ## Example Usage @@ -699,6 +698,10 @@ DeleteSubscriptionGroupPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -708,6 +711,8 @@ DeleteSubscriptionGroupPaymentProfileAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -731,7 +736,7 @@ catch (ApiException e) # Change Subscription Default Payment Profile -This will change the default payment profile on the subscription to the existing payment profile with the id specified. +Changes the default payment profile on the subscription to the existing payment profile with the specified ID. 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. @@ -741,6 +746,10 @@ ChangeSubscriptionDefaultPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -750,6 +759,8 @@ ChangeSubscriptionDefaultPaymentProfileAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -825,6 +836,10 @@ ChangeSubscriptionGroupDefaultPaymentProfileAsync( int paymentProfileId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -834,6 +849,8 @@ ChangeSubscriptionGroupDefaultPaymentProfileAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/payment-profile-response.md) ## Example Usage @@ -907,6 +924,10 @@ ReadOneTimeTokenAsync( string chargifyToken) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -915,6 +936,8 @@ ReadOneTimeTokenAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/get-one-time-token-request.md) ## Example Usage @@ -957,6 +980,10 @@ SendRequestUpdatePaymentEmailAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -965,6 +992,8 @@ SendRequestUpdatePaymentEmailAsync( ## Response Type +**201**: Created + `Task` ## Example Usage diff --git a/doc/controllers/product-families.md b/doc/controllers/product-families.md index 56b95eaf..0f518243 100644 --- a/doc/controllers/product-families.md +++ b/doc/controllers/product-families.md @@ -25,6 +25,10 @@ ListProductsForProductFamilyAsync( Models.ListProductsForProductFamilyInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -33,6 +37,8 @@ ListProductsForProductFamilyAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/product-response.md) ## Example Usage @@ -174,7 +180,7 @@ catch (ApiException e) # Create Product Family -Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components and coupons. +Creates a Product Family within your Advanced Billing site. Create a Product Family to act as a container for your products, components, and coupons. Full documentation on how Product Families operate within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families). @@ -183,6 +189,10 @@ CreateProductFamilyAsync( Models.CreateProductFamilyRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -191,6 +201,8 @@ CreateProductFamilyAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/product-family-response.md) ## Example Usage @@ -242,13 +254,17 @@ catch (ApiException e) # List Product Families -Retrieve a list of Product Families for a site. +Returns a list of Product Families for a site. ```csharp ListProductFamiliesAsync( Models.ListProductFamiliesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -257,6 +273,8 @@ ListProductFamiliesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/product-family-response.md) ## Example Usage @@ -320,6 +338,10 @@ ReadProductFamilyAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -328,6 +350,8 @@ ReadProductFamilyAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-family-response.md) ## Example Usage diff --git a/doc/controllers/product-price-points.md b/doc/controllers/product-price-points.md index f6f7394e..18b4e687 100644 --- a/doc/controllers/product-price-points.md +++ b/doc/controllers/product-price-points.md @@ -33,6 +33,10 @@ CreateProductPricePointAsync( Models.CreateProductPricePointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -42,6 +46,8 @@ CreateProductPricePointAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/product-price-point-response.md) ## Example Usage @@ -129,6 +135,10 @@ ListProductPricePointsAsync( Models.ListProductPricePointsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -137,6 +147,8 @@ ListProductPricePointsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-product-price-points-response.md) ## Example Usage @@ -203,6 +215,10 @@ UpdateProductPricePointAsync( Models.UpdateProductPricePointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -213,6 +229,8 @@ UpdateProductPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-price-point-response.md) ## Example Usage @@ -275,7 +293,7 @@ catch (ApiException e) # Read Product Price Point -Use this endpoint to retrieve details for a specific product price point. You can achieve this by using either the product price point ID or handle. +Returns details for a specific product price point. You can achieve this by using either the product price point ID or handle. ```csharp ReadProductPricePointAsync( @@ -284,6 +302,10 @@ ReadProductPricePointAsync( bool? currencyPrices = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -294,6 +316,8 @@ ReadProductPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-price-point-response.md) ## Example Usage @@ -354,6 +378,10 @@ ArchiveProductPricePointAsync( ArchiveProductPricePointPricePointId pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -363,6 +391,8 @@ ArchiveProductPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-price-point-response.md) ## Example Usage @@ -425,7 +455,7 @@ catch (ApiException e) # Unarchive Product Price Point -Use this endpoint to unarchive an archived product price point. +Unarchives an archived product price point. ```csharp UnarchiveProductPricePointAsync( @@ -433,6 +463,10 @@ UnarchiveProductPricePointAsync( int pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -442,6 +476,8 @@ UnarchiveProductPricePointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-price-point-response.md) ## Example Usage @@ -502,6 +538,10 @@ PromoteProductPricePointToDefaultAsync( int pricePointId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -511,6 +551,8 @@ PromoteProductPricePointToDefaultAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -595,6 +637,10 @@ BulkCreateProductPricePointsAsync( Models.BulkCreateProductPricePointsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -604,6 +650,8 @@ BulkCreateProductPricePointsAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/bulk-create-product-price-points-response.md) ## Example Usage @@ -712,6 +760,10 @@ CreateProductCurrencyPricesAsync( Models.CreateProductCurrencyPricesRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -721,6 +773,8 @@ CreateProductCurrencyPricesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/currency-prices-response.md) ## Example Usage @@ -807,6 +861,10 @@ UpdateProductCurrencyPricesAsync( Models.UpdateCurrencyPricesRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -816,6 +874,8 @@ UpdateProductCurrencyPricesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/currency-prices-response.md) ## Example Usage @@ -882,13 +942,17 @@ catch (ApiException e) # List All Product Price Points -This method allows retrieval of a list of Products Price Points belonging to a Site. +Lists Product Price Points belonging to a site. ```csharp ListAllProductPricePointsAsync( Models.ListAllProductPricePointsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -897,6 +961,8 @@ ListAllProductPricePointsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-product-price-points-response.md) ## Example Usage diff --git a/doc/controllers/products.md b/doc/controllers/products.md index a02c8635..9e3d3343 100644 --- a/doc/controllers/products.md +++ b/doc/controllers/products.md @@ -22,7 +22,7 @@ ProductsController productsController = client.ProductsController; Creates a product in your Advanced Billing site. -See the following product docuemation for more information: +See the following product documentation for more information: + [Products Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-Products-Overview) + [Changing a Subscription's Product](https://maxio.zendesk.com/hc/en-us/articles/24252069837581-Product-Changes-and-Migrations) @@ -33,6 +33,10 @@ CreateProductAsync( Models.CreateOrUpdateProductRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -42,6 +46,8 @@ CreateProductAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -147,6 +153,10 @@ ReadProductAsync( int productId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -155,6 +165,8 @@ ReadProductAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -233,6 +245,10 @@ UpdateProductAsync( Models.CreateOrUpdateProductRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -242,6 +258,8 @@ UpdateProductAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -319,7 +337,7 @@ catch (ApiException e) # Archive Product -Archives the product. All current subscribers will be unffected; their subscription/purchase will continue to be charged monthly. +Archives the product. All current subscribers will be unaffected; their subscription/purchase will continue to be charged monthly. 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. @@ -328,6 +346,10 @@ ArchiveProductAsync( int productId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -336,6 +358,8 @@ ArchiveProductAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -415,6 +439,10 @@ ReadProductByHandleAsync( string apiHandle) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -423,6 +451,8 @@ ReadProductByHandleAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/product-response.md) ## Example Usage @@ -510,13 +540,17 @@ catch (ApiException e) # List Products -This method allows to retrieve a list of Products belonging to a Site. +Lists products belonging to a site. ```csharp ListProductsAsync( Models.ListProductsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -525,6 +559,8 @@ ListProductsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/product-response.md) ## Example Usage diff --git a/doc/controllers/proforma-invoices.md b/doc/controllers/proforma-invoices.md index e43d0537..3558c881 100644 --- a/doc/controllers/proforma-invoices.md +++ b/doc/controllers/proforma-invoices.md @@ -24,7 +24,7 @@ ProformaInvoicesController proformaInvoicesController = client.ProformaInvoicesC # Create Consolidated Proforma Invoice -This endpoint will trigger the creation of a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. +Creates a consolidated proforma invoice asynchronously. It will return a 201 with no message, or a 422 with any errors. To find and view the new consolidated proforma invoice, you may poll the subscription group listing for proforma invoices; only one consolidated proforma invoice may be created per group at a time. If the information becomes outdated, simply void the old consolidated proforma invoice and generate a new one. @@ -37,6 +37,10 @@ CreateConsolidatedProformaInvoiceAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -45,6 +49,8 @@ CreateConsolidatedProformaInvoiceAsync( ## Response Type +**201**: Created + `Task` ## Example Usage @@ -74,7 +80,7 @@ catch (ApiException e) # List Subscription Group Proforma Invoices -Only proforma invoices with a `consolidation_level` of parent are returned. +Lists proforma invoices with a `consolidation_level` of parent for the subscription group. By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to true. @@ -83,6 +89,10 @@ ListSubscriptionGroupProformaInvoicesAsync( Models.ListSubscriptionGroupProformaInvoicesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -91,6 +101,8 @@ ListSubscriptionGroupProformaInvoicesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-proforma-invoices-response.md) ## Example Usage @@ -126,7 +138,7 @@ catch (ApiException e) # Read Proforma Invoice -Use this endpoint to read the details of an existing proforma invoice. +Returns the details of an existing proforma invoice. ## Restrictions @@ -137,6 +149,10 @@ ReadProformaInvoiceAsync( string proformaInvoiceUid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -145,6 +161,8 @@ ReadProformaInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -170,7 +188,7 @@ catch (ApiException e) # Create Proforma Invoice -This endpoint will create a proforma invoice and return it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. +Creates a proforma invoice and returns it as a response. If the information becomes outdated, simply void the old proforma invoice and generate a new one. If you would like to preview the next billing amounts without generating a full proforma invoice, use the renewal preview endpoint. @@ -183,6 +201,10 @@ CreateProformaInvoiceAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -191,6 +213,8 @@ CreateProformaInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -220,13 +244,17 @@ catch (ApiException e) # List Proforma Invoices -By default, proforma invoices returned on the index will only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. +Lists proforma invoices for a subscription. By default, results only include totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`, `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the specific field as a key in the query with a value set to `true`. ```csharp ListProformaInvoicesAsync( Models.ListProformaInvoicesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -235,6 +263,8 @@ ListProformaInvoicesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-proforma-invoices-response.md) ## Example Usage @@ -267,7 +297,7 @@ catch (ApiException e) # Deliver Proforma Invoice -Allows for proforma invoices to be programmatically delivered via email. Supports email +Delivers a proforma invoice programmatically via email. Supports email delivery to direct recipients, carbon-copy (cc) recipients, and blind carbon-copy (bcc) recipients. If `recipient_emails` is omitted, the system will fall back to the primary recipient derived from the invoice or @@ -280,6 +310,10 @@ DeliverProformaInvoiceAsync( Models.DeliverProformaInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -289,6 +323,8 @@ DeliverProformaInvoiceAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -338,7 +374,7 @@ catch (ApiException e) # Void Proforma Invoice -This endpoint will void a proforma invoice that has the status "draft". +Voids a proforma invoice that has the status "draft". ## Restrictions @@ -354,6 +390,10 @@ VoidProformaInvoiceAsync( Models.VoidInvoiceRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -363,6 +403,8 @@ VoidProformaInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -393,7 +435,7 @@ catch (ApiException e) # Preview Proforma Invoice -Return a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. +Returns a preview of the data that will be included on a given subscription's proforma invoice if one were to be generated. It will have similar line items and totals as a renewal preview, but the response will be presented in the format of a proforma invoice. Consequently it will include additional information such as the name and addresses that will appear on the proforma invoice. The preview endpoint is subject to all the same conditions as the proforma invoice endpoint. For example, previews are only available on the Relationship Invoicing architecture, and previews cannot be made for end-of-life subscriptions. @@ -406,6 +448,10 @@ PreviewProformaInvoiceAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -414,6 +460,8 @@ PreviewProformaInvoiceAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -444,9 +492,7 @@ catch (ApiException e) # Create Signup Proforma Invoice -This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. - -Create a proforma invoice to preview costs before a subscription's signup. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. +Creates a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoices or preview prepaid subscriptions. Like other proforma invoices, it can be emailed to the customer, voided, and publicly viewed on the chargifypay domain. Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. @@ -457,6 +503,10 @@ CreateSignupProformaInvoiceAsync( Models.CreateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -465,6 +515,8 @@ CreateSignupProformaInvoiceAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/proforma-invoice.md) ## Example Usage @@ -512,9 +564,7 @@ catch (ApiException e) # Preview Signup Proforma Invoice -This endpoint is only available for Relationship Invoicing sites. It cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. - -Create a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. You have the option of optionally previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. +Creates a signup preview in the format of a proforma invoice to preview costs before a subscription's signup. This endpoint is only available for Relationship Invoicing sites and cannot be used to create consolidated proforma invoice previews or preview prepaid subscriptions. You have the option of previewing the first renewal's costs as well. The proforma invoice preview will not be persisted. Pass a payload that resembles a subscription create or signup preview request. For example, you can specify components, coupons/a referral, offers, custom pricing, and an existing customer or payment profile to populate a shipping or billing address. @@ -526,6 +576,10 @@ PreviewSignupProformaInvoiceAsync( Models.CreateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -535,6 +589,8 @@ PreviewSignupProformaInvoiceAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/signup-proforma-preview-response.md) ## Example Usage diff --git a/doc/controllers/reason-codes.md b/doc/controllers/reason-codes.md index ea726484..b5838efd 100644 --- a/doc/controllers/reason-codes.md +++ b/doc/controllers/reason-codes.md @@ -19,9 +19,11 @@ ReasonCodesController reasonCodesController = client.ReasonCodesController; # Create Reason Code +Creates a reason code for a given site. + # Reason Codes Intro -ReasonCodes are a way to gain a high level view of why your customers are cancelling the subscription to your product or service. +Reason Codes are a way to gain a high-level view of why your customers are cancelling the subscription to your product or service. Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel. @@ -33,13 +35,17 @@ Full documentation on how Reason Codes operate within Advanced Billing can be lo ## Create Reason Code -This method gives a merchant the option to create a reason codes for a given Site. +This method gives a merchant the option to create reason codes for a given site. ```csharp CreateReasonCodeAsync( Models.CreateReasonCodeRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -48,6 +54,8 @@ CreateReasonCodeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/reason-code-response.md) ## Example Usage @@ -86,13 +94,17 @@ catch (ApiException e) # List Reason Codes -This method gives a merchant the option to retrieve a list of all of the current churn codes for a given site. +Lists all current churn codes for a given site. ```csharp ListReasonCodesAsync( Models.ListReasonCodesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -101,6 +113,8 @@ ListReasonCodesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/reason-code-response.md) ## Example Usage @@ -175,13 +189,17 @@ catch (ApiException e) # Read Reason Code -This method gives a merchant the option to retrieve a list of a particular code for a given Site by providing the unique numerical ID of the code. +Returns a particular churn reason code for a given site by its unique ID. ```csharp ReadReasonCodeAsync( int reasonCodeId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -190,6 +208,8 @@ ReadReasonCodeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/reason-code-response.md) ## Example Usage @@ -215,7 +235,7 @@ catch (ApiException e) # Update Reason Code -This method gives a merchant the option to update an existing reason code for a given site. +Updates an existing reason code for a given site. ```csharp UpdateReasonCodeAsync( @@ -223,6 +243,10 @@ UpdateReasonCodeAsync( Models.UpdateReasonCodeRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -232,6 +256,8 @@ UpdateReasonCodeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/reason-code-response.md) ## Example Usage @@ -262,13 +288,17 @@ catch (ApiException e) # Delete Reason Code -This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. +Deletes a reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible. ```csharp DeleteReasonCodeAsync( int reasonCodeId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -277,6 +307,8 @@ DeleteReasonCodeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/ok-response.md) ## Example Usage diff --git a/doc/controllers/referral-codes.md b/doc/controllers/referral-codes.md index b7a7ac65..6b695e9b 100644 --- a/doc/controllers/referral-codes.md +++ b/doc/controllers/referral-codes.md @@ -11,7 +11,7 @@ ReferralCodesController referralCodesController = client.ReferralCodesController # Validate Referral Code -Use this method to determine if the referral code is valid and applicable within your Site. This method is useful for validating referral codes that are entered by a customer. +Validates whether a referral code is valid and applicable within your site. This method is useful for validating referral codes that are entered by a customer. ## Referrals Documentation @@ -26,6 +26,10 @@ ValidateReferralCodeAsync( string code) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -34,6 +38,8 @@ ValidateReferralCodeAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/referral-validation-response.md) ## Example Usage diff --git a/doc/controllers/sales-commissions.md b/doc/controllers/sales-commissions.md index 977c8c3f..d6d18c21 100644 --- a/doc/controllers/sales-commissions.md +++ b/doc/controllers/sales-commissions.md @@ -17,7 +17,7 @@ SalesCommissionsController salesCommissionsController = client.SalesCommissionsC # List Sales Commission Settings -Endpoint returns subscriptions with associated sales reps +Lists subscriptions with associated sales reps. ## Modified Authentication Process @@ -32,6 +32,10 @@ ListSalesCommissionSettingsAsync( Models.ListSalesCommissionSettingsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -40,6 +44,8 @@ ListSalesCommissionSettingsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/sale-rep-settings.md) ## Example Usage @@ -100,7 +106,7 @@ catch (ApiException e) # List Sales Reps -Endpoint returns sales rep list with details +Returns a sales rep list with details. ## Modified Authentication Process @@ -115,6 +121,10 @@ ListSalesRepsAsync( Models.ListSalesRepsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -123,6 +133,8 @@ ListSalesRepsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/list-sale-rep-item.md) ## Example Usage @@ -232,7 +244,7 @@ catch (ApiException e) # Read Sales Rep -Endpoint returns sales rep and attached subscriptions details. +Returns a sales rep and attached subscription details. ## Modified Authentication Process @@ -252,6 +264,10 @@ ReadSalesRepAsync( int? perPage = 100) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -265,6 +281,8 @@ ReadSalesRepAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/sale-rep.md) ## Example Usage diff --git a/doc/controllers/sites.md b/doc/controllers/sites.md index 10f254e8..cb637cc5 100644 --- a/doc/controllers/sites.md +++ b/doc/controllers/sites.md @@ -17,15 +17,15 @@ SitesController sitesController = client.SitesController; # Read Site -This endpoint allows you to fetch some site data. +Retrieves site data. Full documentation on Sites in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/sections/24250550707085-Sites). -Specifically, the [Clearing Site Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365-Clearing-Site-Data) section is extremely relevant to this endpoint documentation. +Specifically, the [Clearing Site Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365-Clearing-Site-Data) section is relevant to this endpoint documentation. #### Relationship invoicing enabled -If site has RI enabled then you will see more settings like: +If the site has RI enabled then you will see more settings like: "customer_hierarchy_enabled": true, "whopays_enabled": true, @@ -38,8 +38,14 @@ You can read more about these settings here: ReadSiteAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**200**: OK + [`Task`](../../doc/models/site-response.md) ## Example Usage @@ -109,7 +115,7 @@ catch (ApiException e) # Clear Site -This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. +Clears all data from a test site asynchronously. This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding. **This functionality will only work on sites in TEST mode. Attempts to perform this on sites in “live” mode will result in a response of 403 FORBIDDEN.** @@ -118,6 +124,10 @@ ClearSiteAsync( Models.CleanupScope? cleanupScope = Models.CleanupScope.All) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -126,6 +136,8 @@ ClearSiteAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -145,13 +157,17 @@ catch (ApiException e) # List Chargify Js Public Keys -This endpoint returns public keys used for Chargify.js. +Returns public keys used for Maxio.js (formerly Chargify.js). ```csharp ListChargifyJsPublicKeysAsync( Models.ListChargifyJsPublicKeysInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -160,6 +176,8 @@ ListChargifyJsPublicKeysAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-public-keys-response.md) ## Example Usage diff --git a/doc/controllers/subscription-components.md b/doc/controllers/subscription-components.md index 5bc06b08..47b01531 100644 --- a/doc/controllers/subscription-components.md +++ b/doc/controllers/subscription-components.md @@ -31,7 +31,7 @@ SubscriptionComponentsController subscriptionComponentsController = client.Subsc # Read Subscription Component -This request will list information regarding a specific component owned by a subscription. +Returns information for a specific component on a subscription. ```csharp ReadSubscriptionComponentAsync( @@ -39,6 +39,10 @@ ReadSubscriptionComponentAsync( int componentId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -48,6 +52,8 @@ ReadSubscriptionComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-component-response.md) ## Example Usage @@ -96,7 +102,7 @@ catch (ApiException e) # List Subscription Components -This request will list a subscription's applied components. +Lists a subscription's applied components. ## Archived Components @@ -107,6 +113,10 @@ ListSubscriptionComponentsAsync( Models.ListSubscriptionComponentsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -115,6 +125,8 @@ ListSubscriptionComponentsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/subscription-component-response.md) ## Example Usage @@ -204,6 +216,10 @@ BulkUpdateSubscriptionComponentsPricePointsAsync( Models.BulkComponentsPricePointAssignment body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -213,6 +229,8 @@ BulkUpdateSubscriptionComponentsPricePointsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/bulk-components-price-point-assignment.md) ## Example Usage @@ -293,6 +311,10 @@ BulkResetSubscriptionComponentsPricePointsAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -301,6 +323,8 @@ BulkResetSubscriptionComponentsPricePointsAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -424,7 +448,7 @@ Creates an allocation, sets the current allocated quantity for the component, an When creating an allocation via the API, you can pass the `upgrade_charge`, `downgrade_credit`, and `accrue_charge` to be applied. -> **Note:** These proration and accural fields are ignored for Prepaid Components since this component type always generate charges immediately without proration. +> **Note:** These proration and accrual fields are ignored for Prepaid Components since this component type always generates charges immediately without proration. For information on prorated components and upgrade/downgrade schemes, see [Setting Component Allocations.](https://maxio.zendesk.com/hc/en-us/articles/24251906165133-Component-Allocations-Proration) @@ -442,7 +466,7 @@ For information on prorated components and upgrade/downgrade schemes, see [Setti > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. -For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. +For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. ```csharp AllocateComponentAsync( @@ -451,6 +475,10 @@ AllocateComponentAsync( Models.CreateAllocationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -461,6 +489,8 @@ AllocateComponentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/allocation-response.md) ## Example Usage @@ -573,7 +603,7 @@ catch (ApiException e) # List Allocations -This endpoint returns the 50 most recent Allocations, ordered by most recent first. +Returns the 50 most recent Allocations, ordered by most recent first. ## On/Off Components @@ -586,6 +616,10 @@ ListAllocationsAsync( int? page = 1) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -596,6 +630,8 @@ ListAllocationsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/allocation-response.md) ## Example Usage @@ -677,7 +713,7 @@ catch (ApiException e) # Allocate Components -Creates multiple allocations, sets the current allocated quantity for each of the components, and recording a memo. A `component_id` is required for each allocation. +Creates multiple allocations, sets the current allocated quantity for each of the components, and records a memo. A `component_id` is required for each allocation. The charges and/or credits that are created will be rolled up into a single total which is used to determine whether this is an upgrade or a downgrade. @@ -695,7 +731,7 @@ The charges and/or credits that are created will be rolled up into a single tota > **Note:** Proration uses the current price of the component as well as the current tax rates. Changes to either may cause the prorated charge/credit to be wrong. -For more informaiton see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product Documentation. +For more information, see the [Component Allocations](https://maxio.zendesk.com/hc/en-us/articles/24251883961485-Component-Allocations-Overview) product documentation. ```csharp AllocateComponentsAsync( @@ -703,6 +739,10 @@ AllocateComponentsAsync( Models.AllocateComponents body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -712,6 +752,8 @@ AllocateComponentsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/allocation-response.md) ## Example Usage @@ -809,7 +851,7 @@ catch (ApiException e) # Preview Allocations -Advanced Billing offers the ability to preview a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. +Previews a potential subscription's **quantity-based** or **on/off** component allocation in the middle of the current billing period. This is useful if you want users to be able to see the effect of a component operation before actually doing it. ## Fine-grained Component Control: Use with multiple `upgrade_charge`s or `downgrade_credits` @@ -823,6 +865,10 @@ PreviewAllocationsAsync( Models.PreviewAllocationsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -832,6 +878,8 @@ PreviewAllocationsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/allocation-preview-response.md) ## Example Usage @@ -984,7 +1032,7 @@ catch (ApiException e) # Update Prepaid Usage Allocation Expiration Date -When the expiration interval options are selected on a prepaid usage component price point, all allocations will be created with an expiration date. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. +Updates the expiration date for a prepaid usage allocation. This expiration date can be changed after the fact to allow for extending or shortening the allocation's active window. In order to change a prepaid usage allocation's expiration date, a PUT call must be made to the allocation's endpoint with a new expiration date. @@ -1004,6 +1052,10 @@ UpdatePrepaidUsageAllocationExpirationDateAsync( Models.UpdateAllocationExpirationDate body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1015,6 +1067,8 @@ UpdatePrepaidUsageAllocationExpirationDateAsync( ## Response Type +**204**: OK + `Task` ## Example Usage @@ -1062,7 +1116,9 @@ catch (ApiException e) # Delete Prepaid Usage Allocation -Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component each allocation must be destroyed individually via this endpoint. +Deletes a prepaid usage allocation. + +Prepaid Usage components are unique in that their allocations are always additive. In order to reduce a subscription's allocated quantity for a prepaid usage component, each allocation must be destroyed individually via this endpoint. ## Credit Scheme @@ -1080,6 +1136,10 @@ DeletePrepaidUsageAllocationAsync( Models.CreditSchemeRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1091,6 +1151,8 @@ DeletePrepaidUsageAllocationAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -1139,11 +1201,11 @@ You can report metered or prepaid usage to Advanced Billing as often as you wish Full documentation on how to create Components in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). Additionally, for information on how to record component usage against a subscription, see the following resources: -It is not possible to record metered usage for more than one component at a time Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. +It is not possible to record metered usage for more than one component at a time. Usage should be reported as one API call per component on a single subscription. For example, to record that a subscriber has sent both an SMS Message and an Email, send an API call for each. -See the following product documention articles for more information: +See the following product documentation articles for more information: -- [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components). A +- [Create and Manage Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-Edit-and-Archive-Components) - [Recording Metered Component Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-metered-component-usage) - [Reporting Prepaid Component Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporting-Component-Allocations#reporting-prepaid-component-status) @@ -1192,6 +1254,10 @@ CreateUsageAsync( Models.CreateUsageRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1202,6 +1268,8 @@ CreateUsageAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/usage-response.md) ## Example Usage @@ -1265,7 +1333,7 @@ catch (ApiException e) # List Usages -This request will return a list of the usages associated with a subscription for a particular metered component. This will display the previously recorded components for a subscription. +Returns a list of usages associated with a subscription for a particular metered component. This will display the previously recorded components for a subscription. This endpoint is not compatible with quantity-based components. @@ -1286,6 +1354,10 @@ ListUsagesAsync( Models.ListUsagesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1294,6 +1366,8 @@ ListUsagesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/usage-response.md) ## Example Usage @@ -1351,6 +1425,8 @@ catch (ApiException e) # Activate Event Based Component +Activates an event-based component for a single subscription. + In order to bill your subscribers on your Events data under the Events-Based Billing feature, the components must be activated for the subscriber. Learn more about the role of activation in the [Events-Based Billing docs](https://maxio.zendesk.com/hc/en-us/articles/24260323329805-Events-Based-Billing-Overview). @@ -1366,6 +1442,10 @@ ActivateEventBasedComponentAsync( Models.ActivateEventBasedComponent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1376,6 +1456,8 @@ ActivateEventBasedComponentAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -1425,7 +1507,7 @@ catch (ApiException e) # Deactivate Event Based Component -Use this endpoint to deactivate an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. +Deactivates an event-based component for a single subscription. Deactivating the event-based component causes Advanced Billing to ignore related events at subscription renewal. ```csharp DeactivateEventBasedComponentAsync( @@ -1433,6 +1515,10 @@ DeactivateEventBasedComponentAsync( int componentId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1442,6 +1528,8 @@ DeactivateEventBasedComponentAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -1465,6 +1553,8 @@ catch (ApiException e) # Record Event +Records a single event for Events-Based Billing. + ## Documentation Events-Based Billing is an evolved form of metered billing that is based on data-rich events streamed in real-time from your system to Advanced Billing. @@ -1492,6 +1582,10 @@ RecordEventAsync( Models.EBBEvent body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1502,6 +1596,8 @@ RecordEventAsync( ## Response Type +**201**: Created + `Task` ## Example Usage @@ -1536,7 +1632,7 @@ catch (ApiException e) # Bulk Record Events -Use this endpoint to record a collection of events. +Records a collection of events. *Note: this endpoint differs from the standard Chargify API endpoints in that the subdomain will be `events` and your site subdomain will be included in the URL path.* @@ -1549,6 +1645,10 @@ BulkRecordEventsAsync( List body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1559,6 +1659,8 @@ BulkRecordEventsAsync( ## Response Type +**201**: Created + `Task` ## Example Usage @@ -1596,13 +1698,17 @@ catch (ApiException e) # List Subscription Components for Site -This request will list components applied to each subscription. +Lists components applied to each subscription. ```csharp ListSubscriptionComponentsForSiteAsync( Models.ListSubscriptionComponentsForSiteInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1611,6 +1717,8 @@ ListSubscriptionComponentsForSiteAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-subscription-components-response.md) ## Example Usage diff --git a/doc/controllers/subscription-group-invoice-account.md b/doc/controllers/subscription-group-invoice-account.md index cd917d86..23e95808 100644 --- a/doc/controllers/subscription-group-invoice-account.md +++ b/doc/controllers/subscription-group-invoice-account.md @@ -18,7 +18,7 @@ SubscriptionGroupInvoiceAccountController subscriptionGroupInvoiceAccountControl # Create Subscription Group Prepayment -A prepayment can be added for a subscription group identified by the group's `uid`. This endpoint requires a `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. +Adds a prepayment for a subscription group. This endpoint requires an `amount`, `details`, `method`, and `memo`. On success, the prepayment will be added to the group's prepayment balance. ```csharp CreateSubscriptionGroupPrepaymentAsync( @@ -26,6 +26,10 @@ CreateSubscriptionGroupPrepaymentAsync( Models.SubscriptionGroupPrepaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -35,6 +39,8 @@ CreateSubscriptionGroupPrepaymentAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-group-prepayment-response.md) ## Example Usage @@ -76,13 +82,17 @@ catch (ApiException e) # List Prepayments for Subscription Group -This request will list a subscription group's prepayments. +Lists a subscription group's prepayments. ```csharp ListPrepaymentsForSubscriptionGroupAsync( Models.ListPrepaymentsForSubscriptionGroupInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -91,6 +101,8 @@ ListPrepaymentsForSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-subscription-group-prepayment-response.md) ## Example Usage @@ -150,7 +162,7 @@ catch (ApiException e) # Issue Subscription Group Service Credit -Credit can be issued for a subscription group identified by the group's `uid`. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. +Issues service credit for a subscription group. Credit will be added to the group in the amount specified in the request body. The credit will be applied to group member invoices as they are generated. ```csharp IssueSubscriptionGroupServiceCreditAsync( @@ -158,6 +170,10 @@ IssueSubscriptionGroupServiceCreditAsync( Models.IssueServiceCreditRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -167,6 +183,8 @@ IssueSubscriptionGroupServiceCreditAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/service-credit-response.md) ## Example Usage @@ -222,7 +240,7 @@ catch (ApiException e) # Deduct Subscription Group Service Credit -Credit can be deducted for a subscription group identified by the group's `uid`. Credit will be deducted from the group in the amount specified in the request body. +Deducts service credit for a subscription group. Credit will be deducted from the group in the amount specified in the request body. ```csharp DeductSubscriptionGroupServiceCreditAsync( @@ -230,6 +248,10 @@ DeductSubscriptionGroupServiceCreditAsync( Models.DeductServiceCreditRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -239,6 +261,8 @@ DeductSubscriptionGroupServiceCreditAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/service-credit.md) ## Example Usage diff --git a/doc/controllers/subscription-group-status.md b/doc/controllers/subscription-group-status.md index 9830eeea..1fabe675 100644 --- a/doc/controllers/subscription-group-status.md +++ b/doc/controllers/subscription-group-status.md @@ -28,6 +28,10 @@ CancelSubscriptionsInGroupAsync( Models.CancelGroupedSubscriptionsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -37,6 +41,8 @@ CancelSubscriptionsInGroupAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -74,7 +80,7 @@ catch (ApiException e) # Initiate Delayed Cancellation for Group -This endpoint will schedule all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. +Schedules all subscriptions within the specified group to be canceled at the end of their billing period. The group is identified by its uid passed in the URL. All subscriptions in the group must be on automatic billing in order to successfully cancel them, and the group must not be in a "past_due" state. @@ -83,6 +89,10 @@ InitiateDelayedCancellationForGroupAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -91,6 +101,8 @@ InitiateDelayedCancellationForGroupAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -120,6 +132,8 @@ catch (ApiException e) # Cancel Delayed Cancellation for Group +Removes the delayed cancellation on a subscription group. + Removing the delayed cancellation on a subscription group will ensure that the subscriptions do not get canceled at the end of the period. The request will reset the `cancel_at_end_of_period` flag to false on each member in the group. ```csharp @@ -127,6 +141,10 @@ CancelDelayedCancellationForGroupAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -135,6 +153,8 @@ CancelDelayedCancellationForGroupAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -164,15 +184,15 @@ catch (ApiException e) # Reactivate Subscription Group -This endpoint will attempt to reactivate or resume a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. +Reactivates or resumes a cancelled subscription group. Upon reactivation, any canceled invoices created after the beginning of the primary subscription's billing period will be reopened and payment will be attempted on them. If the subscription group is being reactivated (as opposed to resumed), new charges will also be assessed for the new billing period. Whether a subscription group is reactivated (a new billing period is created) or resumed (the current billing period is respected) will depend on the parameters that are sent with the request as well as the date of the request relative to the primary subscription's period. ## Reactivating within the current period -If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period the `resume=true` option must be passed in request parameters. +If a subscription group is cancelled and reactivated within the primary subscription's current period, we can choose to either start a new billing period or maintain the existing one. If we want to maintain the existing billing period, the `resume=true` option must be passed in request parameters. -An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed the request will return an error. +An exception to the above are subscriptions that are on calendar billing. These subscriptions cannot be reactivated within the current period. If the `resume=true` option is not passed, the request will return an error. The `resume_members` option is ignored in this case. All eligible group members will be automatically resumed. @@ -184,12 +204,22 @@ Member subscriptions can have billing periods that are longer than the primary ( For calendar billing subscriptions, the new billing period created will be a partial one, spanning from the date of reactivation to the next corresponding calendar renewal date. +## 3D Secure (3DS) Authentication post-authentication flow + +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. + +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. + ```csharp ReactivateSubscriptionGroupAsync( string uid, Models.ReactivateSubscriptionGroupRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -199,6 +229,8 @@ ReactivateSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/reactivate-subscription-group-response.md) ## Example Usage diff --git a/doc/controllers/subscription-groups.md b/doc/controllers/subscription-groups.md index c08a9b83..97990116 100644 --- a/doc/controllers/subscription-groups.md +++ b/doc/controllers/subscription-groups.md @@ -10,7 +10,7 @@ SubscriptionGroupsController subscriptionGroupsController = client.SubscriptionG ## Methods -* [Signup With Subscription Group](../../doc/controllers/subscription-groups.md#signup-with-subscription-group) +* [Signup with Subscription Group](../../doc/controllers/subscription-groups.md#signup-with-subscription-group) * [Create Subscription Group](../../doc/controllers/subscription-groups.md#create-subscription-group) * [List Subscription Groups](../../doc/controllers/subscription-groups.md#list-subscription-groups) * [Read Subscription Group](../../doc/controllers/subscription-groups.md#read-subscription-group) @@ -18,12 +18,12 @@ SubscriptionGroupsController subscriptionGroupsController = client.SubscriptionG * [Delete Subscription Group](../../doc/controllers/subscription-groups.md#delete-subscription-group) * [Find Subscription Group](../../doc/controllers/subscription-groups.md#find-subscription-group) * [Add Subscription to Group](../../doc/controllers/subscription-groups.md#add-subscription-to-group) -* [Remove Subscription From Group](../../doc/controllers/subscription-groups.md#remove-subscription-from-group) +* [Remove Subscription from Group](../../doc/controllers/subscription-groups.md#remove-subscription-from-group) -# Signup With Subscription Group +# Signup with Subscription Group -Create multiple subscriptions at once under the same customer and consolidate them into a subscription group. +Creates multiple subscriptions at once under the same customer and consolidates them into a subscription group. You must provide one and only one of the `payer_id`/`payer_reference`/`payer_attributes` for the customer attached to the group. @@ -31,15 +31,19 @@ You must provide one and only one of the `payment_profile_id`/`credit_card_attri Only one of the `subscriptions` can have `"primary": true` attribute set. -When passing product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. +When passing a product to a subscription you can use either `product_id` or `product_handle` or `offer_id`. You can also use `custom_price` instead. The subscription request examples below will be split into two sections. -The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Chargify.js. +The first section, "Subscription Customization", will focus on passing different information with a subscription, such as components, calendar billing, and custom fields. These examples will presume you are using a secure chargify_token generated by Maxio.js (formerly Chargify.js). ```csharp SignupWithSubscriptionGroupAsync( Models.SubscriptionGroupSignupRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -48,6 +52,8 @@ SignupWithSubscriptionGroupAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/subscription-group-signup-response.md) ## Example Usage @@ -108,6 +114,10 @@ CreateSubscriptionGroupAsync( Models.CreateSubscriptionGroupRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -116,6 +126,8 @@ CreateSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-group-response.md) ## Example Usage @@ -192,6 +204,10 @@ ListSubscriptionGroupsAsync( Models.ListSubscriptionGroupsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -200,6 +216,8 @@ ListSubscriptionGroupsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-subscription-groups-response.md) ## Example Usage @@ -266,7 +284,7 @@ catch (ApiException e) # Read Subscription Group -Use this endpoint to find subscription group details. +Returns subscription group details. #### Current Billing Amount in Cents @@ -278,6 +296,10 @@ ReadSubscriptionGroupAsync( List include = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -287,6 +309,8 @@ ReadSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/full-subscription-group-response.md) ## Example Usage @@ -356,8 +380,8 @@ catch (ApiException e) # Update Subscription Group Members -Use this endpoint to update subscription group members. -`"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from subscription group. To clean up members, just leave the array empty. +Updates subscription group members. +`"member_ids"` should contain an array of both subscription IDs to set as group members and subscription IDs already present in the groups. Not including them will result in removing them from the subscription group. To clean up members, just leave the array empty. ```csharp UpdateSubscriptionGroupMembersAsync( @@ -365,6 +389,10 @@ UpdateSubscriptionGroupMembersAsync( Models.UpdateSubscriptionGroupRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -374,6 +402,8 @@ UpdateSubscriptionGroupMembersAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-group-response.md) ## Example Usage @@ -448,6 +478,10 @@ DeleteSubscriptionGroupAsync( string uid) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -456,6 +490,8 @@ DeleteSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/delete-subscription-group-response.md) ## Example Usage @@ -490,15 +526,19 @@ catch (ApiException e) # Find Subscription Group -Use this endpoint to find subscription group associated with subscription. +Finds the subscription group associated with a subscription. -If the subscription is not in a group endpoint will return 404 code. +If the subscription is not in a group, the endpoint will return a 404 code. ```csharp FindSubscriptionGroupAsync( string subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -507,6 +547,8 @@ FindSubscriptionGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/full-subscription-group-response.md) ## Example Usage @@ -594,6 +636,10 @@ AddSubscriptionToGroupAsync( Models.AddSubscriptionToAGroup body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -603,6 +649,8 @@ AddSubscriptionToGroupAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-group-response.md) ## Example Usage @@ -663,15 +711,19 @@ catch (ApiException e) ``` -# Remove Subscription From Group +# Remove Subscription from Group -For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove existing subscription from subscription group. +For sites making use of the [Relationship Billing](https://maxio.zendesk.com/hc/en-us/articles/24252287829645-Advanced-Billing-Invoices-Overview) and [Customer Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Customer-Hierarchies-WhoPays#customer-hierarchies) features, it is possible to remove an existing subscription from a subscription group. ```csharp RemoveSubscriptionFromGroupAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -680,6 +732,8 @@ RemoveSubscriptionFromGroupAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage diff --git a/doc/controllers/subscription-invoice-account.md b/doc/controllers/subscription-invoice-account.md index 4825144d..8ce09596 100644 --- a/doc/controllers/subscription-invoice-account.md +++ b/doc/controllers/subscription-invoice-account.md @@ -28,6 +28,10 @@ ReadAccountBalancesAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -36,6 +40,8 @@ ReadAccountBalancesAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/account-balances.md) ## Example Usage @@ -55,7 +61,7 @@ catch (ApiException e) # Create Prepayment -## Create Prepayment +Creates a prepayment for a subscription. In order to specify a prepayment made against a subscription, specify the `amount, memo, details, method`. @@ -63,12 +69,22 @@ When the `method` specified is `"credit_card_on_file"`, the prepayment amount wi Note that passing `amount_in_cents` is now allowed. +## 3D Secure (3DS) Authentication post-authentication flow + +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. + +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. + ```csharp CreatePrepaymentAsync( int subscriptionId, Models.CreatePrepaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -78,6 +94,8 @@ CreatePrepaymentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/create-prepayment-response.md) ## Example Usage @@ -133,13 +151,17 @@ catch (ApiException e) # List Prepayments -This request will list a subscription's prepayments. +Lists a subscription's prepayments. ```csharp ListPrepaymentsAsync( Models.ListPrepaymentsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -148,6 +170,8 @@ ListPrepaymentsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/prepayments-response.md) ## Example Usage @@ -206,7 +230,7 @@ catch (ApiException e) # Issue Service Credit -Credit will be added to the subscription in the amount specified in the request body. The credit is subsequently applied to the next generated invoice. +Adds a service credit to the subscription in the specified amount. The credit is subsequently applied to the next generated invoice. ```csharp IssueServiceCreditAsync( @@ -214,6 +238,10 @@ IssueServiceCreditAsync( Models.IssueServiceCreditRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -223,6 +251,8 @@ IssueServiceCreditAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/service-credit.md) ## Example Usage @@ -271,7 +301,7 @@ catch (ApiException e) # Deduct Service Credit -Credit will be removed from the subscription in the amount specified in the request body. The credit amount being deducted must be equal to or less than the current credit balance. +Deducts a service credit from the subscription in the specified amount. The credit amount being deducted must be equal to or less than the current credit balance. ```csharp DeductServiceCreditAsync( @@ -279,6 +309,10 @@ DeductServiceCreditAsync( Models.DeductServiceCreditRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -288,6 +322,8 @@ DeductServiceCreditAsync( ## Response Type +**201**: OK + `Task` ## Example Usage @@ -325,7 +361,7 @@ catch (ApiException e) # List Service Credits -This request will list a subscription's service credits. +Lists a subscription's service credits. ```csharp ListServiceCreditsAsync( @@ -335,6 +371,10 @@ ListServiceCreditsAsync( Models.SortingDirection? direction = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -346,6 +386,8 @@ ListServiceCreditsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/list-service-credits-response.md) ## Example Usage @@ -411,7 +453,7 @@ catch (ApiException e) # Refund Prepayment -This endpoint will refund, completely or partially, a particular prepayment applied to a subscription. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. +Refunds a prepayment applied to a subscription, either fully or partially. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded. The amount may be passed either as a decimal, with `amount`, or an integer in cents, with `amount_in_cents`. @@ -422,6 +464,10 @@ RefundPrepaymentAsync( Models.RefundPrepaymentRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -432,6 +478,8 @@ RefundPrepaymentAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/prepayment-response.md) ## Example Usage diff --git a/doc/controllers/subscription-notes.md b/doc/controllers/subscription-notes.md index a29fdf0b..9fd40d9e 100644 --- a/doc/controllers/subscription-notes.md +++ b/doc/controllers/subscription-notes.md @@ -19,7 +19,7 @@ SubscriptionNotesController subscriptionNotesController = client.SubscriptionNot # Create Subscription Note -Use the following method to create a note for a subscription. +Creates a note for a subscription. ## How to Use Subscription Notes @@ -35,6 +35,10 @@ CreateSubscriptionNoteAsync( Models.UpdateSubscriptionNoteRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -44,6 +48,8 @@ CreateSubscriptionNoteAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-note-response.md) ## Example Usage @@ -85,13 +91,17 @@ catch (ApiException e) # List Subscription Notes -Use this method to retrieve a list of Notes associated with a Subscription. The response will be an array of Notes. +Retrieves a list of notes associated with a subscription. The response will be an array of Notes. ```csharp ListSubscriptionNotesAsync( Models.ListSubscriptionNotesInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -100,6 +110,8 @@ ListSubscriptionNotesAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/subscription-note-response.md) ## Example Usage @@ -162,7 +174,7 @@ catch (ApiException e) # Read Subscription Note -Once you have obtained the ID of the note you wish to read, use this method to show a particular note attached to a subscription. +Retrieves a specific note attached to a subscription. ```csharp ReadSubscriptionNoteAsync( @@ -170,6 +182,10 @@ ReadSubscriptionNoteAsync( int noteId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -179,6 +195,8 @@ ReadSubscriptionNoteAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-note-response.md) ## Example Usage @@ -217,7 +235,7 @@ catch (ApiException e) # Update Subscription Note -Use the following method to update a note for a Subscription. +Updates a note for a subscription. ```csharp UpdateSubscriptionNoteAsync( @@ -226,6 +244,10 @@ UpdateSubscriptionNoteAsync( Models.UpdateSubscriptionNoteRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -236,6 +258,8 @@ UpdateSubscriptionNoteAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-note-response.md) ## Example Usage @@ -287,6 +311,10 @@ DeleteSubscriptionNoteAsync( int noteId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -296,6 +324,8 @@ DeleteSubscriptionNoteAsync( ## Response Type +**200**: OK + `Task` ## Example Usage diff --git a/doc/controllers/subscription-products.md b/doc/controllers/subscription-products.md index fae92bc5..aad987e7 100644 --- a/doc/controllers/subscription-products.md +++ b/doc/controllers/subscription-products.md @@ -16,6 +16,8 @@ SubscriptionProductsController subscriptionProductsController = client.Subscript # Migrate Subscription Product +Migrates a subscription to a different product. + In order to create a migration, you must pass the `product_id` or `product_handle` in the object when you send a POST request. You may also pass either a `product_price_point_id` or `product_price_point_handle` to choose which price point the subscription is moved to. If no price point identifier is passed the subscription will be moved to the products default price point. The response will be the updated subscription. ## Valid Subscriptions @@ -30,48 +32,13 @@ Full documentation on how to record Migrations in the Advanced Billing UI can be ## Failed Migrations -Importaint note: One of the most common ways that a migration can fail is when the attempt is made to migrate a subscription to its current product. - -## Migration 3D Secure - Stripe - -When a payment requires 3D Secure Authentication to adhear to Strong Customer Authentication (SCA) when the subscription is migrated to a new product, the request enters a [post-authentication flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-Implementing-3D-Secure#psd2-flows-pre-authentication-and-post-authentication). The server returns `422 Unprocessable Entity` in this case with the following response: - -```json -{ - "errors": [ - "Your card was declined. This transaction requires 3D secure authentication." - ], - "gateway_payment_id": "pi_1F0aGoJ2UDb3Q4av7zU3sHPh", - "description": "This card requires 3D secure authentication. Redirect the customer to the URL from the action_link attribute to authenticate. Attach callback_url param to this URL if you want to be notified about the result of 3D Secure authentication. Attach redirect_url param to this URL if you want to redirect a customer back to your page after 3D Secure authentication. Example: https://mysite.chargify.com/3d-secure/pi_1FCm4RKDeye4C0XfbqquXRYm?one_time_token_id=128&callback_url=https://localhost:4000&redirect_url=https://yourpage.com will do a POST request to https://localhost:4000 after payment is authenticated and will redirect a customer to https://yourpage.com after 3DS authentication.", - "action_link": "http://acme.chargify.com/3d-secure/pi_1F0aGoJ2UDb3Q4av7zU3sHPh?one_time_token_id=242" -} -``` - -To let the customer go through 3D Secure Authentication, they need to be redirected to the URL specified in `action_link`. -Optionally, you can specify `callback_url` parameter in the `action_link` URL if you’d like to be notified about the result of 3D Secure Authentication. The `callback_url` will return the following information: - -- whether the authentication was successful (`success`) -- the gateway ID for the payment (`gateway_payment_id`) -- the subscription ID (`subscription_id`) +Important note: One of the most common ways that a migration can fail is when the attempt is made to migrate a subscription to its current product. -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. +## 3D Secure (3DS) Authentication post-authentication flow -It is not possible to use `action_link` in an iframe inside a custom application. You have to redirect the customer directly to the `action_link`, then, to be notified about the result, use `redirect_url` or `callback_url`. +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. -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` - -### Example Redirect Flow - -You may wish to redirect customers to different pages depending on whether SCA was performed successfully. Here's an example flow to use as a reference: - -1. Create a migration via API; it requires 3DS -2. You receive a `gateway_payment_id` in the `action_link` along other params in the response. -3. Use this `gateway_payment_id` to, for example, connect with your internal resources or generate a session_id -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 -8. Optionally, you can use the applied "msg" param in the `redirect_url` to determine whether it was successful or not. +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. ```csharp MigrateSubscriptionProductAsync( @@ -79,6 +46,10 @@ MigrateSubscriptionProductAsync( Models.SubscriptionProductMigrationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -88,6 +59,8 @@ MigrateSubscriptionProductAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -256,9 +229,11 @@ catch (ApiException e) # Preview Subscription Product Migration +Previews the charges resulting from migrating a subscription to a different product. + ## Previewing a future date -It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (eg: `"proration_date": "2020-12-18T18:25:43.511Z"`). +It is also possible to preview the migration for a date in the future, as long as it's still within the subscription's current billing period, by passing a `proration_date` along with the request (e.g., `"proration_date": "2020-12-18T18:25:43.511Z"`). This will calculate the prorated adjustment, charge, payment and credit applied values assuming the migration is done at that date in the future as opposed to right now. @@ -268,6 +243,10 @@ PreviewSubscriptionProductMigrationAsync( Models.SubscriptionMigrationPreviewRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -277,6 +256,8 @@ PreviewSubscriptionProductMigrationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-migration-preview-response.md) ## Example Usage diff --git a/doc/controllers/subscription-renewals.md b/doc/controllers/subscription-renewals.md index efa2abc7..7143db7d 100644 --- a/doc/controllers/subscription-renewals.md +++ b/doc/controllers/subscription-renewals.md @@ -33,6 +33,10 @@ CreateScheduledRenewalConfigurationAsync( Models.ScheduledRenewalConfigurationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -42,6 +46,8 @@ CreateScheduledRenewalConfigurationAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -142,6 +148,10 @@ ListScheduledRenewalConfigurationsAsync( Models.Status? status = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -151,6 +161,8 @@ ListScheduledRenewalConfigurationsAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configurations-response.md) ## Example Usage @@ -223,6 +235,10 @@ ReadScheduledRenewalConfigurationAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -232,6 +248,8 @@ ReadScheduledRenewalConfigurationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -307,6 +325,10 @@ UpdateScheduledRenewalConfigurationAsync( Models.ScheduledRenewalConfigurationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -317,6 +339,8 @@ UpdateScheduledRenewalConfigurationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -419,6 +443,10 @@ ScheduleScheduledRenewalLockInAsync( Models.ScheduledRenewalLockInRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -429,6 +457,8 @@ ScheduleScheduledRenewalLockInAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -519,6 +549,10 @@ LockInScheduledRenewalImmediatelyAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -528,6 +562,8 @@ LockInScheduledRenewalImmediatelyAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -611,6 +647,10 @@ UnpublishScheduledRenewalConfigurationAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -620,6 +660,8 @@ UnpublishScheduledRenewalConfigurationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -695,6 +737,10 @@ CancelScheduledRenewalConfigurationAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -704,6 +750,8 @@ CancelScheduledRenewalConfigurationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-response.md) ## Example Usage @@ -780,6 +828,10 @@ CreateScheduledRenewalConfigurationItemAsync( Models.ScheduledRenewalConfigurationItemRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -790,6 +842,8 @@ CreateScheduledRenewalConfigurationItemAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/scheduled-renewal-configuration-item-response.md) ## Example Usage @@ -879,6 +933,10 @@ UpdateScheduledRenewalConfigurationItemAsync( Models.ScheduledRenewalUpdateRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -890,6 +948,8 @@ UpdateScheduledRenewalConfigurationItemAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/scheduled-renewal-configuration-item-response.md) ## Example Usage @@ -980,6 +1040,10 @@ DeleteScheduledRenewalConfigurationItemAsync( int id) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -990,6 +1054,8 @@ DeleteScheduledRenewalConfigurationItemAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage diff --git a/doc/controllers/subscription-status.md b/doc/controllers/subscription-status.md index 0c1d1a1c..5c0e0970 100644 --- a/doc/controllers/subscription-status.md +++ b/doc/controllers/subscription-status.md @@ -24,21 +24,23 @@ SubscriptionStatusController subscriptionStatusController = client.SubscriptionS # Retry Subscription -Advanced Billing offers the ability to retry collecting the balance due on a past due Subscription without waiting for the next scheduled attempt. +Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt. -## Successful Reactivation +## 3D Secure (3DS) Authentication post-authentication flow -The response will be `200 OK` with the updated Subscription. +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. -## Failed Reactivation - -The response will be `422 "Unprocessable Entity`. +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. ```csharp RetrySubscriptionAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -47,6 +49,8 @@ RetrySubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -221,6 +225,10 @@ CancelSubscriptionAsync( Models.CancellationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -230,6 +238,8 @@ CancelSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -392,7 +402,7 @@ catch (ApiException e) # Resume Subscription -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. +Resumes 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. ```csharp ResumeSubscriptionAsync( @@ -400,6 +410,10 @@ ResumeSubscriptionAsync( Models.ResumptionCharge? calendarBillingResumptionCharge = Models.ResumptionCharge.Prorated) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -409,6 +423,8 @@ ResumeSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -547,7 +563,7 @@ catch (ApiException e) # Pause Subscription -This will place the subscription in the on_hold state and it will not renew. +Places the subscription on hold, preventing it from renewing. ## Limitations @@ -559,6 +575,10 @@ PauseSubscriptionAsync( Models.PauseRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -568,6 +588,8 @@ PauseSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -719,13 +741,13 @@ catch (ApiException e) # Update Automatic Subscription Resumption -Once a subscription has been paused / put on hold, you can update the date which was specified to automatically resume the subscription. +Updates the date on which a paused subscription will automatically resume. To update a subscription's resume date, use this method to change or update the `automatically_resume_at` date. ### Remove the resume date -Alternately, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. +Alternatively, you can change the `automatically_resume_at` to `null` if you would like the subscription to not have a resume date. ```csharp UpdateAutomaticSubscriptionResumptionAsync( @@ -733,6 +755,10 @@ UpdateAutomaticSubscriptionResumptionAsync( Models.PauseRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -742,6 +768,8 @@ UpdateAutomaticSubscriptionResumptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -904,7 +932,7 @@ catch (ApiException e) # Reactivate Subscription -Reactivate a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). +Reactivates a previously canceled subscription. For details on how the reactivation works, and how to reactivate subscriptions through the application, see [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-Reactivating-and-Resuming). **Note: The term "resume" is used also during another process in Advanced Billing. This occurs when an on-hold subscription is "resumed". This returns the subscription to an active state.** @@ -925,7 +953,7 @@ If a reactivation with `resume: true` were attempted _before_ what would have be If a reactivation with `resume: true` were attempted _after_ what would have been the next billing date of July 1st, then Advanced Billing would not resume the subscription, and instead it would be reactivated with a new billing period. -If a reactivation with `resume: false`, or where 'resume" is omited were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period were possible. +If a reactivation with `resume: false`, or where 'resume' is omitted were attempted, then Advanced Billing would reactivate the subscription with a new billing period regardless of whether or not resuming the previous billing period was possible. | Canceled | Reactivation | Resumable? | |---|---|---| @@ -1065,12 +1093,22 @@ PUT request sent to: + The next billing date should not have changed + Any product-related charges should have been collected +## 3D Secure (3DS) Authentication post-authentication flow + +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. + +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. + ```csharp ReactivateSubscriptionAsync( int subscriptionId, Models.ReactivateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1080,6 +1118,8 @@ ReactivateSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -1243,6 +1283,10 @@ InitiateDelayedCancellationAsync( Models.CancellationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1252,6 +1296,8 @@ InitiateDelayedCancellationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/delayed-cancellation-response.md) ## Example Usage @@ -1282,7 +1328,7 @@ catch (ApiException e) # Cancel Delayed Cancellation -Removing the delayed cancellation on a subscription will ensure that it doesn't get canceled at the end of the period that it is in. The request will reset the `cancel_at_end_of_period` flag to `false`. +Removes the delayed cancellation from a subscription, ensuring it is not canceled at the end of the current period. The request will reset the `cancel_at_end_of_period` flag to `false`. This endpoint is idempotent. If the subscription was not set to cancel in the future, removing the delayed cancellation has no effect and the call will be successful. @@ -1291,6 +1337,10 @@ CancelDelayedCancellationAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1299,6 +1349,8 @@ CancelDelayedCancellationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/delayed-cancellation-response.md) ## Example Usage @@ -1332,13 +1384,17 @@ catch (ApiException e) # Cancel Dunning -If a subscription is currently in dunning, the subscription will be set to active and the active Dunner will be resolved. +Cancels the active dunning process for a subscription and sets it to active. ```csharp CancelDunningAsync( int subscriptionId) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1347,6 +1403,8 @@ CancelDunningAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -1376,7 +1434,7 @@ catch (ApiException e) # Preview Renewal -The Chargify API allows you to preview a renewal by posting to the renewals endpoint. 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. +Previews a subscription’s next renewal assessment. 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. The "Next Billing" amount and "Next Billing" date are already represented in the UI on each Subscriber's Summary. For more information, see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview). @@ -1405,6 +1463,10 @@ PreviewRenewalAsync( Models.RenewalPreviewRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1414,6 +1476,8 @@ PreviewRenewalAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/renewal-preview-response.md) ## Example Usage diff --git a/doc/controllers/subscriptions.md b/doc/controllers/subscriptions.md index c70e7bf0..10cbe5ee 100644 --- a/doc/controllers/subscriptions.md +++ b/doc/controllers/subscriptions.md @@ -20,33 +20,45 @@ SubscriptionsController subscriptionsController = client.SubscriptionsController * [Update Prepaid Subscription Configuration](../../doc/controllers/subscriptions.md#update-prepaid-subscription-configuration) * [Preview Subscription](../../doc/controllers/subscriptions.md#preview-subscription) * [Apply Coupons to Subscription](../../doc/controllers/subscriptions.md#apply-coupons-to-subscription) -* [Remove Coupon From Subscription](../../doc/controllers/subscriptions.md#remove-coupon-from-subscription) +* [Remove Coupon from Subscription](../../doc/controllers/subscriptions.md#remove-coupon-from-subscription) * [Activate Subscription](../../doc/controllers/subscriptions.md#activate-subscription) # Create Subscription -Creates a Subscription for a customer and product +Creates a Subscription for a customer and product. -Specify the product with `product_id` or `product_handle`. To set a specific product pricepPoint, use `product_price_point_handle` or `product_price_point_id`. +Specify the product with `product_id` or `product_handle`. To set a specific product price point, use `product_price_point_handle` or `product_price_point_id`. Identify an existing customer with `customer_id` or `customer_reference`. Optionally, include an existing payment profile using `payment_profile_id`. To create a new customer, pass customer_attributes. Select an option from the **Request Examples** drop-down on the right side of the portal to see examples of common scenarios for creating subscriptions. +See the [Subscription Signups](page:introduction/basic-concepts/subscription-signup) article for more information on working with subscriptions in Advanced Billing. + +## Payment information + Payment information may be required to create a subscription, depending on the options for the Product being subscribed. See [product options](https://docs.maxio.com/hc/en-us/articles/24261076617869-Edit-Products) for more information. See the [Payments Profile](../../doc/controllers/payment-profiles.md#create-payment-profile) endpoint for details on payment parameters. Do not use real card information for testing. See the Sites articles that cover [testing your site setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Overview#testing-overview-0-0) for more details on testing in your sandbox. -Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. +Note that collecting and sending raw card details in production requires [PCI compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Compliance#pci-compliance-0-0) on your end. If your business is not PCI compliant, use [Maxio.js (formerly Chargify.js)](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank account information. -See the [Subscription Signups](page:introduction/basic-concepts/subscription-signup) article for more information on working with subscriptions in Advanced Billing. +## 3D Secure (3DS) Authentication post-authentication flow + +When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication. + +See the [3D Secure Post-Authentication Flow](https://docs.maxio.com/hc/en-us/articles/44277749524365-3D-Secure-Post-Authentication-Flow) article in the product documentation to learn how to manage the redirect flow. ```csharp CreateSubscriptionAsync( Models.CreateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -55,6 +67,8 @@ CreateSubscriptionAsync( ## Response Type +**201**: Created + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -246,7 +260,7 @@ catch (ApiException e) # List Subscriptions -returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. +Returns an array of subscriptions from a Site. Pay close attention to query string filters and pagination in order to control responses from the server. ## Search for a subscription @@ -261,6 +275,10 @@ ListSubscriptionsAsync( Models.ListSubscriptionsInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -269,6 +287,8 @@ ListSubscriptionsAsync( ## Response Type +**200**: OK + [`Task>`](../../doc/models/subscription-response.md) ## Example Usage @@ -340,21 +360,21 @@ You can also perform a delayed change to the price point by passing in either `p ## Billing Date Changes -You can update dates for a subscrption. +You can update dates for a subscription. ### Regular Billing Date Changes Send the `next_billing_at` to set the next billing date for the subscription. After that date passes and the subscription is processed, the following billing date will be set according to the subscription's product period. -> Note: If you pass an invalid date, the correct date is automatically set to he correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. +> Note: If you pass an invalid date, the correct date is automatically set to the correct date. For example, if February 30 is passed, the next billing would be set to March 2nd in a non-leap year. The server response will not return data under the key/value pair of `next_billing_at`. View the key/value pair of `current_period_ends_at` to verify that the `next_billing_at` date has been changed successfully. -### Calendar Billing and Snap Day Changes +### Calendar Billing and Snap Day Changes For a subscription using Calendar Billing, setting the next billing date is a bit different. Send the `snap_day` attribute to change the calendar billing date for **a subscription using a product eligible for calendar billing**. -> Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day`will will reset to 'null on the next billing cycle. This is because a product change is instantanous and only affects the product associated with a subscription. +> Note: If you change the product associated with a subscription that contains a `snap_day` and immediately `READ/GET` the subscription data, it will still contain original `snap_day`. The `snap_day` will reset to null on the next billing cycle. This is because a product change is instantaneous and only affects the product associated with a subscription. ```csharp UpdateSubscriptionAsync( @@ -362,6 +382,10 @@ UpdateSubscriptionAsync( Models.UpdateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -371,6 +395,8 @@ UpdateSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -536,6 +562,10 @@ ReadSubscriptionAsync( List include = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -545,6 +575,8 @@ ReadSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -712,7 +744,7 @@ catch (ApiException e) # Override Subscription -This API endpoint allows you to set certain subscription fields that are usually managed for you automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. +Sets certain subscription fields that are usually managed automatically. Some of the fields can be set via the normal Subscriptions Update API, but others can only be set using this endpoint. This endpoint is provided for cases where you need to “align” Advanced Billing data with data that happened in your system, perhaps before you started using Advanced Billing. For example, you may choose to import your historical subscription data, and would like the activation and cancellation dates in Advanced Billing to match your existing historical dates. Advanced Billing does not backfill historical events (i.e. from the Events API), but some static data can be changed via this API. @@ -738,6 +770,10 @@ OverrideSubscriptionAsync( Models.OverrideSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -747,6 +783,8 @@ OverrideSubscriptionAsync( ## Response Type +**204**: No Content + `Task` ## Example Usage @@ -796,13 +834,17 @@ catch (ApiException e) # Find Subscription -Use this endpoint to find a subscription by its reference. +Finds a subscription by its reference. ```csharp FindSubscriptionAsync( string reference = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -811,6 +853,8 @@ FindSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -835,7 +879,7 @@ catch (ApiException e) # Purge Subscription -For sites in test mode, you may purge individual subscriptions. +Purges an individual subscription for sites in test mode. Provide the subscription ID in the url. To confirm, supply the customer ID in the query string `ack` parameter. You may also delete the customer record and/or payment profiles by passing `cascade` parameters. For example, to delete just the customer record, the query params would be: `?ack={customer_id}&cascade[]=customer` @@ -852,6 +896,10 @@ PurgeSubscriptionAsync( List cascade = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -862,6 +910,8 @@ PurgeSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -902,7 +952,7 @@ catch (ApiException e) # Update Prepaid Subscription Configuration -Use this endpoint to update a subscription's prepaid configuration. +Updates a subscription's prepaid configuration. ```csharp UpdatePrepaidSubscriptionConfigurationAsync( @@ -910,6 +960,10 @@ UpdatePrepaidSubscriptionConfigurationAsync( Models.UpsertPrepaidConfigurationRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -919,6 +973,8 @@ UpdatePrepaidSubscriptionConfigurationAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/prepaid-configuration-response.md) ## Example Usage @@ -972,7 +1028,7 @@ catch (ApiException e) # Preview Subscription -The Chargify API allows you to preview a subscription by POSTing the same JSON or XML as for a subscription creation. +Previews a subscription by POSTing the same JSON or XML as for a subscription creation. The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. @@ -1003,6 +1059,10 @@ PreviewSubscriptionAsync( Models.CreateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1011,6 +1071,8 @@ PreviewSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-preview-response.md) ## Example Usage @@ -1157,6 +1219,8 @@ catch (ApiException e) # Apply Coupons to Subscription +Applies one or more coupon codes to an existing subscription. + An existing subscription can accommodate multiple discounts/coupon codes. This is only applicable if each coupon is stackable. For more information on stackable coupons, we recommend reviewing our [coupon documentation.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#stackability-rules) ## Query Parameters vs Request Body Parameters @@ -1172,6 +1236,10 @@ ApplyCouponsToSubscriptionAsync( Models.AddCouponsRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1182,6 +1250,8 @@ ApplyCouponsToSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage @@ -1372,11 +1442,11 @@ catch (ApiException e) | 422 | Unprocessable Entity (WebDAV) | [`SubscriptionAddCouponErrorException`](../../doc/models/subscription-add-coupon-error-exception.md) | -# Remove Coupon From Subscription +# Remove Coupon from Subscription -Use this endpoint to remove a coupon from an existing subscription. +Removes a coupon from an existing subscription. -For more information on the expected behaviour of removing a coupon from a subscription, See our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon) +For more information on the expected behavior of removing a coupon from a subscription, see our documentation [here.](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-and-Subscriptions#removing-a-coupon) ```csharp RemoveCouponFromSubscriptionAsync( @@ -1384,6 +1454,10 @@ RemoveCouponFromSubscriptionAsync( string couponCode = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1393,6 +1467,8 @@ RemoveCouponFromSubscriptionAsync( ## Response Type +**200**: OK + `Task` ## Example Usage @@ -1428,7 +1504,7 @@ catch (ApiException e) # Activate Subscription -Advanced Billing offers the ability to activate awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. +Activates awaiting signup and trialing subscriptions. This feature is only available on the Relationship Invoicing architecture. Subscriptions in a group may not be activated immediately. For details on how the activation works, and how to activate subscriptions through the application, see [activation](#). @@ -1478,6 +1554,10 @@ ActivateSubscriptionAsync( Models.ActivateSubscriptionRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -1487,6 +1567,8 @@ ActivateSubscriptionAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/subscription-response.md) ## Example Usage diff --git a/doc/controllers/webhooks.md b/doc/controllers/webhooks.md index 85408220..47a3ff39 100644 --- a/doc/controllers/webhooks.md +++ b/doc/controllers/webhooks.md @@ -20,13 +20,17 @@ WebhooksController webhooksController = client.WebhooksController; # List Webhooks -Allows you to view a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. +Retrieves a list of webhooks. You can pass query parameters if you want to filter webhooks. See the [Webhooks](page:introduction/webhooks/webhooks) documentation for more information. ```csharp ListWebhooksAsync( Models.ListWebhooksInput input) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -35,6 +39,8 @@ ListWebhooksAsync( ## Response Type +**201**: OK + [`Task>`](../../doc/models/webhook-response.md) ## Example Usage @@ -98,13 +104,17 @@ catch (ApiException e) # Enable Webhooks -Allows you to enable webhooks for your site +Enables webhooks for your site. ```csharp EnableWebhooksAsync( Models.EnableWebhooksRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -113,6 +123,8 @@ EnableWebhooksAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/enable-webhooks-response.md) ## Example Usage @@ -151,6 +163,10 @@ ReplayWebhooksAsync( Models.ReplayWebhooksRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -159,6 +175,8 @@ ReplayWebhooksAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/replay-webhooks-response.md) ## Example Usage @@ -194,7 +212,7 @@ catch (ApiException e) # Create Endpoint -Creates an endpoint and assigns a list of webhooks subscriptions (events) to it. +Creates an endpoint and assigns a list of webhook subscriptions (events) to it. See the [Webhooks Reference](page:introduction/webhooks/webhooks-reference#events) page for available events. ```csharp @@ -202,6 +220,10 @@ CreateEndpointAsync( Models.CreateOrUpdateEndpointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -210,6 +232,8 @@ CreateEndpointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/endpoint-response.md) ## Example Usage @@ -224,6 +248,7 @@ CreateOrUpdateEndpointRequest body = new CreateOrUpdateEndpointRequest { WebhookSubscription.PaymentSuccess, WebhookSubscription.PaymentFailure, + WebhookSubscription.InvoicePending, }, }, }; @@ -253,7 +278,8 @@ catch (ApiException e) "status": "enabled", "webhook_subscriptions": [ "payment_success", - "payment_failure" + "payment_failure", + "invoice_pending" ] } } @@ -274,8 +300,14 @@ Returns created endpoints for a site. ListEndpointsAsync() ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Response Type +**200**: OK + [`Task>`](../../doc/models/endpoint.md) ## Example Usage @@ -302,7 +334,8 @@ catch (ApiException e) "status": "enabled", "webhook_subscriptions": [ "payment_success", - "payment_failure" + "payment_failure", + "invoice_pending" ] }, { @@ -326,7 +359,7 @@ Updates an Endpoint. You can change the `url` of your endpoint or the list of `w Always send a complete list of events to which you want to subscribe. Sending a PUT request for an existing endpoint with an empty list of `webhook_subscriptions` will unsubscribe all events. -If you want unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. +If you want to unsubscribe from a specific event, send a list of `webhook_subscriptions` without the specific event key. ```csharp UpdateEndpointAsync( @@ -334,6 +367,10 @@ UpdateEndpointAsync( Models.CreateOrUpdateEndpointRequest body = null) ``` +## Authentication + +This endpoint requires [BasicAuth](../../doc/auth/basic-authentication.md) + ## Parameters | Parameter | Type | Tags | Description | @@ -343,6 +380,8 @@ UpdateEndpointAsync( ## Response Type +**200**: OK + [`Task`](../../doc/models/endpoint-response.md) ## Example Usage @@ -359,6 +398,7 @@ CreateOrUpdateEndpointRequest body = new CreateOrUpdateEndpointRequest WebhookSubscription.PaymentFailure, WebhookSubscription.PaymentSuccess, WebhookSubscription.RefundFailure, + WebhookSubscription.InvoicePending, }, }, }; diff --git a/doc/models/activate-event-based-component.md b/doc/models/activate-event-based-component.md index 3bf5b26b..71cabf21 100644 --- a/doc/models/activate-event-based-component.md +++ b/doc/models/activate-event-based-component.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `PricePointId` | `int?` | Optional | The Chargify id of the price point | -| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. | +| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. | | `CustomPrice` | [`ComponentCustomPrice`](../../doc/models/component-custom-price.md) | Optional | Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. | ## Example (as JSON) diff --git a/doc/models/bank-account-payment-profile.md b/doc/models/bank-account-payment-profile.md index 2d6acdd8..503eda2c 100644 --- a/doc/models/bank-account-payment-profile.md +++ b/doc/models/bank-account-payment-profile.md @@ -14,7 +14,7 @@ | `LastName` | `string` | Optional | The last name of the bank account holder | | `CustomerId` | `int?` | Optional | The Chargify-assigned id for the customer record to which the bank account belongs | | `CurrentVault` | [`BankAccountVault?`](../../doc/models/bank-account-vault.md) | Optional | The vault that stores the payment profile with the provided vault_token. Use `bogus` for testing. | -| `VaultToken` | `string` | Optional | The “token” provided by your vault storage for an already stored payment profile | +| `VaultToken` | `string` | Optional | The "token" provided by your vault storage for an already stored payment profile | | `BillingAddress` | `string` | Optional | The current billing street address for the bank account | | `BillingCity` | `string` | Optional | The current billing address city for the bank account | | `BillingState` | `string` | Optional | The current billing address state for the bank account | @@ -23,8 +23,8 @@ | `CustomerVaultToken` | `string` | Optional | (only for Authorize.Net CIM storage): the customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token. | | `BillingAddress2` | `string` | Optional | The current billing street address, second line, for the bank account | | `BankName` | `string` | Optional | The bank where the account resides | -| `MaskedBankRoutingNumber` | `string` | Optional | A string representation of the stored bank routing number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’). payment_type will be bank_account | -| `MaskedBankAccountNumber` | `string` | Required | A string representation of the stored bank account number with all but the last 4 digits marked with X’s (i.e. ‘XXXXXXX1111’) | +| `MaskedBankRoutingNumber` | `string` | Optional | A string representation of the stored bank routing number with all but the last 4 digits marked with X's (i.e. 'XXXXXXX1111'). payment_type will be bank_account | +| `MaskedBankAccountNumber` | `string` | Optional | A string representation of the stored bank account number with all but the last 4 digits marked with X's (i.e. 'XXXXXXX1111') | | `BankAccountType` | [`BankAccountType?`](../../doc/models/bank-account-type.md) | Optional | Defaults to checking | | `BankAccountHolderType` | [`BankAccountHolderType?`](../../doc/models/bank-account-holder-type.md) | Optional | Defaults to personal | | `PaymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.bank_account` | @@ -38,7 +38,6 @@ ```json { - "masked_bank_account_number": "masked_bank_account_number8", "payment_type": "bank_account", "verified": false, "id": 188, diff --git a/doc/models/bank-account-response.md b/doc/models/bank-account-response.md index e1c0ba0b..249b7a45 100644 --- a/doc/models/bank-account-response.md +++ b/doc/models/bank-account-response.md @@ -16,7 +16,6 @@ ```json { "payment_profile": { - "masked_bank_account_number": "masked_bank_account_number6", "payment_type": "bank_account", "verified": false, "id": 44, diff --git a/doc/models/billing-schedule.md b/doc/models/billing-schedule.md index fd5380bf..d0949ee5 100644 --- a/doc/models/billing-schedule.md +++ b/doc/models/billing-schedule.md @@ -1,7 +1,7 @@ # Billing Schedule -This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. +Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. ## Structure @@ -11,13 +11,13 @@ This attribute is particularly useful when you need to align billing events for | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `InitialBillingAt` | `DateTime?` | Optional | The initial_billing_at attribute in Maxio allows you to specify a custom starting date for billing cycles associated with components that have their own billing frequency set. Only ISO8601 format is supported. | +| `InitialBillingAt` | `DateTime?` | Optional | Custom start date (ISO 8601 date, YYYY-MM-DD) for the component's first billing period. If omitted or null, billing aligns with the product schedule. If provided, date must be on or after the minimum allowed date for the subscription or component. | ## Example (as JSON) ```json { - "initial_billing_at": "2024-01-01" + "initial_billing_at": "2026-01-01" } ``` diff --git a/doc/models/chjs-tokenization-failure.md b/doc/models/chjs-tokenization-failure.md new file mode 100644 index 00000000..0584af0e --- /dev/null +++ b/doc/models/chjs-tokenization-failure.md @@ -0,0 +1,27 @@ + +# Chjs Tokenization Failure + +## Structure + +`ChjsTokenizationFailure` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `Errors` | `string` | Required | - | +| `PaymentProfileParams` | [`PaymentProfileParams`](../../doc/models/payment-profile-params.md) | Optional | PCI-safe cardholder fields only. Full card numbers, CVV, and billing address are never included. | + +## Example (as JSON) + +```json +{ + "errors": "errors2", + "payment_profile_params": { + "first_name": "first_name2", + "last_name": "last_name0", + "card_type": "card_type2" + } +} +``` + diff --git a/doc/models/chjs-tokenization-success.md b/doc/models/chjs-tokenization-success.md new file mode 100644 index 00000000..a23f03d2 --- /dev/null +++ b/doc/models/chjs-tokenization-success.md @@ -0,0 +1,28 @@ + +# Chjs Tokenization Success + +## Structure + +`ChjsTokenizationSuccess` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `PaymentProfile` | [`TokenizedPaymentProfile`](../../doc/models/tokenized-payment-profile.md) | Required | - | +| `GatewayCustomerId` | `int?` | Optional | - | + +## Example (as JSON) + +```json +{ + "payment_profile": { + "id": 44, + "vault_token": "vault_token6", + "gateway_handle": "gateway_handle4", + "customer_vault_token": "customer_vault_token2" + }, + "gateway_customer_id": 44 +} +``` + diff --git a/doc/models/containers/allocation-preview-item-previous-quantity.md b/doc/models/containers/allocation-preview-item-previous-quantity.md index c017de82..d828c62a 100644 --- a/doc/models/containers/allocation-preview-item-previous-quantity.md +++ b/doc/models/containers/allocation-preview-item-previous-quantity.md @@ -12,3 +12,23 @@ | `int` | AllocationPreviewItemPreviousQuantity.FromNumber(int number) | | `string` | AllocationPreviewItemPreviousQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +AllocationPreviewItemPreviousQuantity value = AllocationPreviewItemPreviousQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +AllocationPreviewItemPreviousQuantity value = AllocationPreviewItemPreviousQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/allocation-preview-item-quantity.md b/doc/models/containers/allocation-preview-item-quantity.md index 6b6e352b..55bb721e 100644 --- a/doc/models/containers/allocation-preview-item-quantity.md +++ b/doc/models/containers/allocation-preview-item-quantity.md @@ -12,3 +12,23 @@ | `int` | AllocationPreviewItemQuantity.FromNumber(int number) | | `string` | AllocationPreviewItemQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +AllocationPreviewItemQuantity value = AllocationPreviewItemQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +AllocationPreviewItemQuantity value = AllocationPreviewItemQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/allocation-previous-quantity.md b/doc/models/containers/allocation-previous-quantity.md index faee84b1..619876e8 100644 --- a/doc/models/containers/allocation-previous-quantity.md +++ b/doc/models/containers/allocation-previous-quantity.md @@ -12,3 +12,23 @@ | `int` | AllocationPreviousQuantity.FromNumber(int number) | | `string` | AllocationPreviousQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +AllocationPreviousQuantity value = AllocationPreviousQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +AllocationPreviousQuantity value = AllocationPreviousQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/allocation-quantity.md b/doc/models/containers/allocation-quantity.md index af549dab..891c97ed 100644 --- a/doc/models/containers/allocation-quantity.md +++ b/doc/models/containers/allocation-quantity.md @@ -12,3 +12,23 @@ | `int` | AllocationQuantity.FromNumber(int number) | | `string` | AllocationQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +AllocationQuantity value = AllocationQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +AllocationQuantity value = AllocationQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/archive-component-price-point-component-id.md b/doc/models/containers/archive-component-price-point-component-id.md index 6b3b1d70..8fab8f88 100644 --- a/doc/models/containers/archive-component-price-point-component-id.md +++ b/doc/models/containers/archive-component-price-point-component-id.md @@ -12,3 +12,23 @@ | `int` | ArchiveComponentPricePointComponentId.FromNumber(int number) | | `string` | ArchiveComponentPricePointComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ArchiveComponentPricePointComponentId value = ArchiveComponentPricePointComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ArchiveComponentPricePointComponentId value = ArchiveComponentPricePointComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/archive-component-price-point-price-point-id.md b/doc/models/containers/archive-component-price-point-price-point-id.md index b8cd2f1a..027bb270 100644 --- a/doc/models/containers/archive-component-price-point-price-point-id.md +++ b/doc/models/containers/archive-component-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | ArchiveComponentPricePointPricePointId.FromNumber(int number) | | `string` | ArchiveComponentPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ArchiveComponentPricePointPricePointId value = ArchiveComponentPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ArchiveComponentPricePointPricePointId value = ArchiveComponentPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/archive-product-price-point-price-point-id.md b/doc/models/containers/archive-product-price-point-price-point-id.md index 4d813093..08a601a1 100644 --- a/doc/models/containers/archive-product-price-point-price-point-id.md +++ b/doc/models/containers/archive-product-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | ArchiveProductPricePointPricePointId.FromNumber(int number) | | `string` | ArchiveProductPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ArchiveProductPricePointPricePointId value = ArchiveProductPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ArchiveProductPricePointPricePointId value = ArchiveProductPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/archive-product-price-point-product-id.md b/doc/models/containers/archive-product-price-point-product-id.md index fc2b5353..59b946c3 100644 --- a/doc/models/containers/archive-product-price-point-product-id.md +++ b/doc/models/containers/archive-product-price-point-product-id.md @@ -12,3 +12,23 @@ | `int` | ArchiveProductPricePointProductId.FromNumber(int number) | | `string` | ArchiveProductPricePointProductId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ArchiveProductPricePointProductId value = ArchiveProductPricePointProductId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ArchiveProductPricePointProductId value = ArchiveProductPricePointProductId.FromString("String0"); +``` + diff --git a/doc/models/containers/calendar-billing-snap-day.md b/doc/models/containers/calendar-billing-snap-day.md index ab6aa137..19f6afb2 100644 --- a/doc/models/containers/calendar-billing-snap-day.md +++ b/doc/models/containers/calendar-billing-snap-day.md @@ -12,3 +12,23 @@ | `int` | CalendarBillingSnapDay.FromNumber(int number) | | `string` | CalendarBillingSnapDay.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CalendarBillingSnapDay value = CalendarBillingSnapDay.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CalendarBillingSnapDay value = CalendarBillingSnapDay.FromString("String0"); +``` + diff --git a/doc/models/containers/clone-component-price-point-component-id.md b/doc/models/containers/clone-component-price-point-component-id.md index 56ba7506..f689a27a 100644 --- a/doc/models/containers/clone-component-price-point-component-id.md +++ b/doc/models/containers/clone-component-price-point-component-id.md @@ -12,3 +12,23 @@ | `int` | CloneComponentPricePointComponentId.FromNumber(int number) | | `string` | CloneComponentPricePointComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CloneComponentPricePointComponentId value = CloneComponentPricePointComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CloneComponentPricePointComponentId value = CloneComponentPricePointComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/clone-component-price-point-price-point-id.md b/doc/models/containers/clone-component-price-point-price-point-id.md index 13210183..7965f09a 100644 --- a/doc/models/containers/clone-component-price-point-price-point-id.md +++ b/doc/models/containers/clone-component-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | CloneComponentPricePointPricePointId.FromNumber(int number) | | `string` | CloneComponentPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CloneComponentPricePointPricePointId value = CloneComponentPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CloneComponentPricePointPricePointId value = CloneComponentPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/component-allocation-change-allocated-quantity.md b/doc/models/containers/component-allocation-change-allocated-quantity.md index 41efbb49..f7d5f56c 100644 --- a/doc/models/containers/component-allocation-change-allocated-quantity.md +++ b/doc/models/containers/component-allocation-change-allocated-quantity.md @@ -12,3 +12,23 @@ | `int` | ComponentAllocationChangeAllocatedQuantity.FromNumber(int number) | | `string` | ComponentAllocationChangeAllocatedQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ComponentAllocationChangeAllocatedQuantity value = ComponentAllocationChangeAllocatedQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ComponentAllocationChangeAllocatedQuantity value = ComponentAllocationChangeAllocatedQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/component-price-point-assignment-price-point.md b/doc/models/containers/component-price-point-assignment-price-point.md index 64048090..d75728ca 100644 --- a/doc/models/containers/component-price-point-assignment-price-point.md +++ b/doc/models/containers/component-price-point-assignment-price-point.md @@ -12,3 +12,23 @@ | `string` | ComponentPricePointAssignmentPricePoint.FromString(string mString) | | `int` | ComponentPricePointAssignmentPricePoint.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +ComponentPricePointAssignmentPricePoint value = ComponentPricePointAssignmentPricePoint.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +ComponentPricePointAssignmentPricePoint value = ComponentPricePointAssignmentPricePoint.FromNumber(0); +``` + diff --git a/doc/models/containers/coupon-payload-percentage.md b/doc/models/containers/coupon-payload-percentage.md index 2dc7b0b4..77f72041 100644 --- a/doc/models/containers/coupon-payload-percentage.md +++ b/doc/models/containers/coupon-payload-percentage.md @@ -12,3 +12,23 @@ | `string` | CouponPayloadPercentage.FromString(string mString) | | `double` | CouponPayloadPercentage.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CouponPayloadPercentage value = CouponPayloadPercentage.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CouponPayloadPercentage value = CouponPayloadPercentage.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-allocation-price-point-id.md b/doc/models/containers/create-allocation-price-point-id.md index c9694454..6866726d 100644 --- a/doc/models/containers/create-allocation-price-point-id.md +++ b/doc/models/containers/create-allocation-price-point-id.md @@ -12,3 +12,23 @@ | `string` | CreateAllocationPricePointId.FromString(string mString) | | `int` | CreateAllocationPricePointId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateAllocationPricePointId value = CreateAllocationPricePointId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateAllocationPricePointId value = CreateAllocationPricePointId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-component-price-point-request-price-point.md b/doc/models/containers/create-component-price-point-request-price-point.md index 9bbd4156..f9f478e6 100644 --- a/doc/models/containers/create-component-price-point-request-price-point.md +++ b/doc/models/containers/create-component-price-point-request-price-point.md @@ -12,3 +12,57 @@ | [`CreateComponentPricePoint`](../../../doc/models/create-component-price-point.md) | CreateComponentPricePointRequestPricePoint.FromCreateComponentPricePoint(CreateComponentPricePoint createComponentPricePoint) | | [`CreatePrepaidUsageComponentPricePoint`](../../../doc/models/create-prepaid-usage-component-price-point.md) | CreateComponentPricePointRequestPricePoint.FromCreatePrepaidUsageComponentPricePoint(CreatePrepaidUsageComponentPricePoint createPrepaidUsageComponentPricePoint) | +## CreateComponentPricePoint + +### Initialization Code + +#### Example + +```csharp +CreateComponentPricePointRequestPricePoint value = CreateComponentPricePointRequestPricePoint.FromCreateComponentPricePoint( + new CreateComponentPricePoint + { + Name = "name0", + PricingScheme = PricingScheme.PerUnit, + Prices = new List + { + new Price + { + StartingQuantity = PriceStartingQuantity.FromNumber(242), + UnitPrice = PriceUnitPrice.FromPrecision(23.26), + }, + }, + UseSiteExchangeRate = true, + } +); +``` + +## CreatePrepaidUsageComponentPricePoint + +### Initialization Code + +#### Example + +```csharp +CreateComponentPricePointRequestPricePoint value = CreateComponentPricePointRequestPricePoint.FromCreatePrepaidUsageComponentPricePoint( + new CreatePrepaidUsageComponentPricePoint + { + Name = "name0", + PricingScheme = PricingScheme.PerUnit, + Prices = new List + { + new Price + { + StartingQuantity = PriceStartingQuantity.FromNumber(242), + UnitPrice = PriceUnitPrice.FromPrecision(23.26), + }, + }, + OveragePricing = new OveragePricing + { + PricingScheme = PricingScheme.Stairstep, + }, + UseSiteExchangeRate = true, + } +); +``` + diff --git a/doc/models/containers/create-component-price-points-request-price-points.md b/doc/models/containers/create-component-price-points-request-price-points.md index 6ebdb614..79699694 100644 --- a/doc/models/containers/create-component-price-points-request-price-points.md +++ b/doc/models/containers/create-component-price-points-request-price-points.md @@ -12,3 +12,57 @@ | [`CreateComponentPricePoint`](../../../doc/models/create-component-price-point.md) | CreateComponentPricePointsRequestPricePoints.FromCreateComponentPricePoint(CreateComponentPricePoint createComponentPricePoint) | | [`CreatePrepaidUsageComponentPricePoint`](../../../doc/models/create-prepaid-usage-component-price-point.md) | CreateComponentPricePointsRequestPricePoints.FromCreatePrepaidUsageComponentPricePoint(CreatePrepaidUsageComponentPricePoint createPrepaidUsageComponentPricePoint) | +## CreateComponentPricePoint + +### Initialization Code + +#### Example + +```csharp +CreateComponentPricePointsRequestPricePoints value = CreateComponentPricePointsRequestPricePoints.FromCreateComponentPricePoint( + new CreateComponentPricePoint + { + Name = "name0", + PricingScheme = PricingScheme.PerUnit, + Prices = new List + { + new Price + { + StartingQuantity = PriceStartingQuantity.FromNumber(242), + UnitPrice = PriceUnitPrice.FromPrecision(23.26), + }, + }, + UseSiteExchangeRate = true, + } +); +``` + +## CreatePrepaidUsageComponentPricePoint + +### Initialization Code + +#### Example + +```csharp +CreateComponentPricePointsRequestPricePoints value = CreateComponentPricePointsRequestPricePoints.FromCreatePrepaidUsageComponentPricePoint( + new CreatePrepaidUsageComponentPricePoint + { + Name = "name0", + PricingScheme = PricingScheme.PerUnit, + Prices = new List + { + new Price + { + StartingQuantity = PriceStartingQuantity.FromNumber(242), + UnitPrice = PriceUnitPrice.FromPrecision(23.26), + }, + }, + OveragePricing = new OveragePricing + { + PricingScheme = PricingScheme.Stairstep, + }, + UseSiteExchangeRate = true, + } +); +``` + diff --git a/doc/models/containers/create-invoice-coupon-amount.md b/doc/models/containers/create-invoice-coupon-amount.md index f089126e..c1042e5f 100644 --- a/doc/models/containers/create-invoice-coupon-amount.md +++ b/doc/models/containers/create-invoice-coupon-amount.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceCouponAmount.FromString(string mString) | | `double` | CreateInvoiceCouponAmount.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponAmount value = CreateInvoiceCouponAmount.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponAmount value = CreateInvoiceCouponAmount.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-invoice-coupon-percentage.md b/doc/models/containers/create-invoice-coupon-percentage.md index e35447ae..4cc95130 100644 --- a/doc/models/containers/create-invoice-coupon-percentage.md +++ b/doc/models/containers/create-invoice-coupon-percentage.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceCouponPercentage.FromString(string mString) | | `double` | CreateInvoiceCouponPercentage.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponPercentage value = CreateInvoiceCouponPercentage.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponPercentage value = CreateInvoiceCouponPercentage.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-invoice-coupon-product-family-id.md b/doc/models/containers/create-invoice-coupon-product-family-id.md index 7d8e73ff..f95f9a9b 100644 --- a/doc/models/containers/create-invoice-coupon-product-family-id.md +++ b/doc/models/containers/create-invoice-coupon-product-family-id.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceCouponProductFamilyId.FromString(string mString) | | `int` | CreateInvoiceCouponProductFamilyId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponProductFamilyId value = CreateInvoiceCouponProductFamilyId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceCouponProductFamilyId value = CreateInvoiceCouponProductFamilyId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-invoice-item-component-id.md b/doc/models/containers/create-invoice-item-component-id.md index 9d8d3b2d..88d6f0ec 100644 --- a/doc/models/containers/create-invoice-item-component-id.md +++ b/doc/models/containers/create-invoice-item-component-id.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceItemComponentId.FromString(string mString) | | `int` | CreateInvoiceItemComponentId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemComponentId value = CreateInvoiceItemComponentId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemComponentId value = CreateInvoiceItemComponentId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-invoice-item-price-point-id.md b/doc/models/containers/create-invoice-item-price-point-id.md index 0a4c0bcd..a7a0e6f1 100644 --- a/doc/models/containers/create-invoice-item-price-point-id.md +++ b/doc/models/containers/create-invoice-item-price-point-id.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceItemPricePointId.FromString(string mString) | | `int` | CreateInvoiceItemPricePointId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemPricePointId value = CreateInvoiceItemPricePointId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemPricePointId value = CreateInvoiceItemPricePointId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-invoice-item-product-id.md b/doc/models/containers/create-invoice-item-product-id.md index dfd6423c..6036a590 100644 --- a/doc/models/containers/create-invoice-item-product-id.md +++ b/doc/models/containers/create-invoice-item-product-id.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceItemProductId.FromString(string mString) | | `int` | CreateInvoiceItemProductId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemProductId value = CreateInvoiceItemProductId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemProductId value = CreateInvoiceItemProductId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-invoice-item-product-price-point-id.md b/doc/models/containers/create-invoice-item-product-price-point-id.md index 23b7d84e..3270d3cc 100644 --- a/doc/models/containers/create-invoice-item-product-price-point-id.md +++ b/doc/models/containers/create-invoice-item-product-price-point-id.md @@ -12,3 +12,23 @@ | `string` | CreateInvoiceItemProductPricePointId.FromString(string mString) | | `int` | CreateInvoiceItemProductPricePointId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemProductPricePointId value = CreateInvoiceItemProductPricePointId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemProductPricePointId value = CreateInvoiceItemProductPricePointId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-invoice-item-quantity.md b/doc/models/containers/create-invoice-item-quantity.md index 1cd25620..7710683b 100644 --- a/doc/models/containers/create-invoice-item-quantity.md +++ b/doc/models/containers/create-invoice-item-quantity.md @@ -12,3 +12,23 @@ | `double` | CreateInvoiceItemQuantity.FromPrecision(double precision) | | `string` | CreateInvoiceItemQuantity.FromString(string mString) | +## double + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemQuantity value = CreateInvoiceItemQuantity.FromPrecision(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemQuantity value = CreateInvoiceItemQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/create-invoice-item-unit-price.md b/doc/models/containers/create-invoice-item-unit-price.md index 5c224927..5d586caf 100644 --- a/doc/models/containers/create-invoice-item-unit-price.md +++ b/doc/models/containers/create-invoice-item-unit-price.md @@ -12,3 +12,23 @@ | `double` | CreateInvoiceItemUnitPrice.FromPrecision(double precision) | | `string` | CreateInvoiceItemUnitPrice.FromString(string mString) | +## double + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemUnitPrice value = CreateInvoiceItemUnitPrice.FromPrecision(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoiceItemUnitPrice value = CreateInvoiceItemUnitPrice.FromString("String0"); +``` + diff --git a/doc/models/containers/create-invoice-payment-amount.md b/doc/models/containers/create-invoice-payment-amount.md index f1baa3d1..be316710 100644 --- a/doc/models/containers/create-invoice-payment-amount.md +++ b/doc/models/containers/create-invoice-payment-amount.md @@ -12,3 +12,23 @@ | `string` | CreateInvoicePaymentAmount.FromString(string mString) | | `double` | CreateInvoicePaymentAmount.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateInvoicePaymentAmount value = CreateInvoicePaymentAmount.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateInvoicePaymentAmount value = CreateInvoicePaymentAmount.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-metafields-request-metafields.md b/doc/models/containers/create-metafields-request-metafields.md index 039481f3..c4b27e04 100644 --- a/doc/models/containers/create-metafields-request-metafields.md +++ b/doc/models/containers/create-metafields-request-metafields.md @@ -12,3 +12,49 @@ | [`CreateMetafield`](../../../doc/models/create-metafield.md) | CreateMetafieldsRequestMetafields.FromCreateMetafield(CreateMetafield createMetafield) | | [`List`](../../../doc/models/create-metafield.md) | CreateMetafieldsRequestMetafields.FromListOfCreateMetafield(List listOfCreateMetafield) | +## CreateMetafield + +### Initialization Code + +#### Example + +```csharp +CreateMetafieldsRequestMetafields value = CreateMetafieldsRequestMetafields.FromCreateMetafield( + new CreateMetafield + { + Name = "my_field", + Scope = new MetafieldScope + { + Csv = IncludeOption.Exclude, + Invoices = IncludeOption.Exclude, + Statements = IncludeOption.Exclude, + Portal = IncludeOption.Exclude, + PublicShow = IncludeOption.Exclude, + PublicEdit = IncludeOption.Exclude, + }, + InputType = MetafieldInput.Text, + MEnum = new List + { + "string", + }, + } +); +``` + +## List + +### Initialization Code + +#### Example + +```csharp +CreateMetafieldsRequestMetafields value = CreateMetafieldsRequestMetafields.FromListOfCreateMetafield( + new List + { + new CreateMetafield + { + }, + } +); +``` + diff --git a/doc/models/containers/create-multi-invoice-payment-amount.md b/doc/models/containers/create-multi-invoice-payment-amount.md index 6e78a15a..c5bac375 100644 --- a/doc/models/containers/create-multi-invoice-payment-amount.md +++ b/doc/models/containers/create-multi-invoice-payment-amount.md @@ -12,3 +12,23 @@ | `string` | CreateMultiInvoicePaymentAmount.FromString(string mString) | | `double` | CreateMultiInvoicePaymentAmount.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateMultiInvoicePaymentAmount value = CreateMultiInvoicePaymentAmount.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateMultiInvoicePaymentAmount value = CreateMultiInvoicePaymentAmount.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-or-update-segment-price-unit-price.md b/doc/models/containers/create-or-update-segment-price-unit-price.md index 7ef77d00..cd3711f4 100644 --- a/doc/models/containers/create-or-update-segment-price-unit-price.md +++ b/doc/models/containers/create-or-update-segment-price-unit-price.md @@ -12,3 +12,23 @@ | `string` | CreateOrUpdateSegmentPriceUnitPrice.FromString(string mString) | | `double` | CreateOrUpdateSegmentPriceUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateOrUpdateSegmentPriceUnitPrice value = CreateOrUpdateSegmentPriceUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateOrUpdateSegmentPriceUnitPrice value = CreateOrUpdateSegmentPriceUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/create-payment-profile-expiration-month.md b/doc/models/containers/create-payment-profile-expiration-month.md index 1d630d4e..77f948ce 100644 --- a/doc/models/containers/create-payment-profile-expiration-month.md +++ b/doc/models/containers/create-payment-profile-expiration-month.md @@ -12,3 +12,23 @@ | `int` | CreatePaymentProfileExpirationMonth.FromNumber(int number) | | `string` | CreatePaymentProfileExpirationMonth.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreatePaymentProfileExpirationMonth value = CreatePaymentProfileExpirationMonth.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreatePaymentProfileExpirationMonth value = CreatePaymentProfileExpirationMonth.FromString("String0"); +``` + diff --git a/doc/models/containers/create-payment-profile-expiration-year.md b/doc/models/containers/create-payment-profile-expiration-year.md index 6ff9d180..788a2369 100644 --- a/doc/models/containers/create-payment-profile-expiration-year.md +++ b/doc/models/containers/create-payment-profile-expiration-year.md @@ -12,3 +12,23 @@ | `int` | CreatePaymentProfileExpirationYear.FromNumber(int number) | | `string` | CreatePaymentProfileExpirationYear.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreatePaymentProfileExpirationYear value = CreatePaymentProfileExpirationYear.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreatePaymentProfileExpirationYear value = CreatePaymentProfileExpirationYear.FromString("String0"); +``` + diff --git a/doc/models/containers/create-product-price-point-product-id.md b/doc/models/containers/create-product-price-point-product-id.md index 3693228e..ec5cfaa8 100644 --- a/doc/models/containers/create-product-price-point-product-id.md +++ b/doc/models/containers/create-product-price-point-product-id.md @@ -12,3 +12,23 @@ | `int` | CreateProductPricePointProductId.FromNumber(int number) | | `string` | CreateProductPricePointProductId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateProductPricePointProductId value = CreateProductPricePointProductId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateProductPricePointProductId value = CreateProductPricePointProductId.FromString("String0"); +``` + diff --git a/doc/models/containers/create-segment-segment-property-1-value.md b/doc/models/containers/create-segment-segment-property-1-value.md index 74734531..1daf4acb 100644 --- a/doc/models/containers/create-segment-segment-property-1-value.md +++ b/doc/models/containers/create-segment-segment-property-1-value.md @@ -14,3 +14,43 @@ | `int` | CreateSegmentSegmentProperty1Value.FromNumber(int number) | | `bool` | CreateSegmentSegmentProperty1Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty1Value value = CreateSegmentSegmentProperty1Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty1Value value = CreateSegmentSegmentProperty1Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty1Value value = CreateSegmentSegmentProperty1Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty1Value value = CreateSegmentSegmentProperty1Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/create-segment-segment-property-2-value.md b/doc/models/containers/create-segment-segment-property-2-value.md index 81c35a85..861796b9 100644 --- a/doc/models/containers/create-segment-segment-property-2-value.md +++ b/doc/models/containers/create-segment-segment-property-2-value.md @@ -14,3 +14,43 @@ | `int` | CreateSegmentSegmentProperty2Value.FromNumber(int number) | | `bool` | CreateSegmentSegmentProperty2Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty2Value value = CreateSegmentSegmentProperty2Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty2Value value = CreateSegmentSegmentProperty2Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty2Value value = CreateSegmentSegmentProperty2Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty2Value value = CreateSegmentSegmentProperty2Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/create-segment-segment-property-3-value.md b/doc/models/containers/create-segment-segment-property-3-value.md index a66a0894..f02e7f72 100644 --- a/doc/models/containers/create-segment-segment-property-3-value.md +++ b/doc/models/containers/create-segment-segment-property-3-value.md @@ -14,3 +14,43 @@ | `int` | CreateSegmentSegmentProperty3Value.FromNumber(int number) | | `bool` | CreateSegmentSegmentProperty3Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty3Value value = CreateSegmentSegmentProperty3Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty3Value value = CreateSegmentSegmentProperty3Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty3Value value = CreateSegmentSegmentProperty3Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty3Value value = CreateSegmentSegmentProperty3Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/create-segment-segment-property-4-value.md b/doc/models/containers/create-segment-segment-property-4-value.md index 388a6ede..99fc992d 100644 --- a/doc/models/containers/create-segment-segment-property-4-value.md +++ b/doc/models/containers/create-segment-segment-property-4-value.md @@ -14,3 +14,43 @@ | `int` | CreateSegmentSegmentProperty4Value.FromNumber(int number) | | `bool` | CreateSegmentSegmentProperty4Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty4Value value = CreateSegmentSegmentProperty4Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty4Value value = CreateSegmentSegmentProperty4Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty4Value value = CreateSegmentSegmentProperty4Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +CreateSegmentSegmentProperty4Value value = CreateSegmentSegmentProperty4Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/create-subscription-component-allocated-quantity.md b/doc/models/containers/create-subscription-component-allocated-quantity.md index cf6ca69f..2e6e7fee 100644 --- a/doc/models/containers/create-subscription-component-allocated-quantity.md +++ b/doc/models/containers/create-subscription-component-allocated-quantity.md @@ -12,3 +12,23 @@ | `int` | CreateSubscriptionComponentAllocatedQuantity.FromNumber(int number) | | `string` | CreateSubscriptionComponentAllocatedQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentAllocatedQuantity value = CreateSubscriptionComponentAllocatedQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentAllocatedQuantity value = CreateSubscriptionComponentAllocatedQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/create-subscription-component-component-id.md b/doc/models/containers/create-subscription-component-component-id.md index ef7c6cde..0d387ef0 100644 --- a/doc/models/containers/create-subscription-component-component-id.md +++ b/doc/models/containers/create-subscription-component-component-id.md @@ -12,3 +12,23 @@ | `int` | CreateSubscriptionComponentComponentId.FromNumber(int number) | | `string` | CreateSubscriptionComponentComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentComponentId value = CreateSubscriptionComponentComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentComponentId value = CreateSubscriptionComponentComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/create-subscription-component-price-point-id.md b/doc/models/containers/create-subscription-component-price-point-id.md index 2005d872..2839519c 100644 --- a/doc/models/containers/create-subscription-component-price-point-id.md +++ b/doc/models/containers/create-subscription-component-price-point-id.md @@ -12,3 +12,23 @@ | `int` | CreateSubscriptionComponentPricePointId.FromNumber(int number) | | `string` | CreateSubscriptionComponentPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentPricePointId value = CreateSubscriptionComponentPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionComponentPricePointId value = CreateSubscriptionComponentPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/create-subscription-offer-id.md b/doc/models/containers/create-subscription-offer-id.md index 76534f30..a6703330 100644 --- a/doc/models/containers/create-subscription-offer-id.md +++ b/doc/models/containers/create-subscription-offer-id.md @@ -12,3 +12,23 @@ | `string` | CreateSubscriptionOfferId.FromString(string mString) | | `int` | CreateSubscriptionOfferId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionOfferId value = CreateSubscriptionOfferId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +CreateSubscriptionOfferId value = CreateSubscriptionOfferId.FromNumber(0); +``` + diff --git a/doc/models/containers/create-usage-component-id.md b/doc/models/containers/create-usage-component-id.md index 13763345..a177cab0 100644 --- a/doc/models/containers/create-usage-component-id.md +++ b/doc/models/containers/create-usage-component-id.md @@ -12,3 +12,23 @@ | `int` | CreateUsageComponentId.FromNumber(int number) | | `string` | CreateUsageComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateUsageComponentId value = CreateUsageComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateUsageComponentId value = CreateUsageComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/create-usage-subscription-id-or-reference.md b/doc/models/containers/create-usage-subscription-id-or-reference.md index 9e1dcff7..ad1820a6 100644 --- a/doc/models/containers/create-usage-subscription-id-or-reference.md +++ b/doc/models/containers/create-usage-subscription-id-or-reference.md @@ -12,3 +12,23 @@ | `int` | CreateUsageSubscriptionIdOrReference.FromNumber(int number) | | `string` | CreateUsageSubscriptionIdOrReference.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +CreateUsageSubscriptionIdOrReference value = CreateUsageSubscriptionIdOrReference.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +CreateUsageSubscriptionIdOrReference value = CreateUsageSubscriptionIdOrReference.FromString("String0"); +``` + diff --git a/doc/models/containers/customer-error-response-errors.md b/doc/models/containers/customer-error-response-errors.md index a4a426bc..61808f84 100644 --- a/doc/models/containers/customer-error-response-errors.md +++ b/doc/models/containers/customer-error-response-errors.md @@ -12,3 +12,32 @@ | [`CustomerError`](../../../doc/models/customer-error.md) | CustomerErrorResponseErrors.FromCustomerError(CustomerError customerError) | | `List` | CustomerErrorResponseErrors.FromListOfString(List listOfString) | +## CustomerError + +### Initialization Code + +#### Example + +```csharp +CustomerErrorResponseErrors value = CustomerErrorResponseErrors.FromCustomerError( + new CustomerError + { + } +); +``` + +## List + +### Initialization Code + +#### Example + +```csharp +CustomerErrorResponseErrors value = CustomerErrorResponseErrors.FromListOfString( + new List + { + "String1", + } +); +``` + diff --git a/doc/models/containers/deduct-service-credit-amount.md b/doc/models/containers/deduct-service-credit-amount.md index a2d5d76d..5e17f88a 100644 --- a/doc/models/containers/deduct-service-credit-amount.md +++ b/doc/models/containers/deduct-service-credit-amount.md @@ -12,3 +12,23 @@ | `string` | DeductServiceCreditAmount.FromString(string mString) | | `double` | DeductServiceCreditAmount.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +DeductServiceCreditAmount value = DeductServiceCreditAmount.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +DeductServiceCreditAmount value = DeductServiceCreditAmount.FromPrecision(0); +``` + diff --git a/doc/models/containers/ebb-component-unit-price.md b/doc/models/containers/ebb-component-unit-price.md index 44d668c9..a9c6f7ec 100644 --- a/doc/models/containers/ebb-component-unit-price.md +++ b/doc/models/containers/ebb-component-unit-price.md @@ -12,3 +12,23 @@ | `string` | EBBComponentUnitPrice.FromString(string mString) | | `double` | EBBComponentUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +EBBComponentUnitPrice value = EBBComponentUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +EBBComponentUnitPrice value = EBBComponentUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/event-event-specific-data.md b/doc/models/containers/event-event-specific-data.md index a4b80b2d..759e85cd 100644 --- a/doc/models/containers/event-event-specific-data.md +++ b/doc/models/containers/event-event-specific-data.md @@ -27,4 +27,438 @@ | [`PaymentCollectionMethodChanged`](../../../doc/models/payment-collection-method-changed.md) | EventEventSpecificData.FromPaymentCollectionMethodChanged(PaymentCollectionMethodChanged paymentCollectionMethodChanged) | | [`ItemPricePointChanged`](../../../doc/models/item-price-point-changed.md) | EventEventSpecificData.FromItemPricePointChanged(ItemPricePointChanged itemPricePointChanged) | | [`CustomFieldValueChange`](../../../doc/models/custom-field-value-change.md) | EventEventSpecificData.FromCustomFieldValueChange(CustomFieldValueChange customFieldValueChange) | +| [`ChjsTokenizationSuccess`](../../../doc/models/chjs-tokenization-success.md) | EventEventSpecificData.FromChjsTokenizationSuccess(ChjsTokenizationSuccess chjsTokenizationSuccess) | +| [`ChjsTokenizationFailure`](../../../doc/models/chjs-tokenization-failure.md) | EventEventSpecificData.FromChjsTokenizationFailure(ChjsTokenizationFailure chjsTokenizationFailure) | + +## SubscriptionProductChange + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromSubscriptionProductChange( + new SubscriptionProductChange + { + PreviousProductId = 126, + NewProductId = 12, + } +); +``` + +## SubscriptionStateChange + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromSubscriptionStateChange( + new SubscriptionStateChange + { + PreviousSubscriptionState = "previous_subscription_state2", + NewSubscriptionState = "new_subscription_state6", + } +); +``` + +## PaymentRelatedEvents + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPaymentRelatedEvents( + new PaymentRelatedEvents + { + ProductId = 42, + AccountTransactionId = 58, + } +); +``` + +## RefundSuccess + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromRefundSuccess( + new RefundSuccess + { + RefundId = 12, + GatewayTransactionId = 182, + ProductId = 168, + } +); +``` + +## ComponentAllocationChange + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromComponentAllocationChange( + new ComponentAllocationChange + { + PreviousAllocation = 94, + NewAllocation = 102, + ComponentId = 88, + ComponentHandle = "component_handle8", + Memo = "memo2", + AllocationId = 158, + } +); +``` + +## MeteredUsage + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromMeteredUsage( + new MeteredUsage + { + PreviousUnitBalance = "previous_unit_balance6", + NewUnitBalance = 80, + UsageQuantity = 42, + ComponentId = 4, + ComponentHandle = "component_handle8", + Memo = "memo2", + } +); +``` + +## PrepaidUsage + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPrepaidUsage( + new PrepaidUsage + { + PreviousUnitBalance = "previous_unit_balance0", + PreviousOverageUnitBalance = "previous_overage_unit_balance4", + NewUnitBalance = 252, + NewOverageUnitBalance = 224, + UsageQuantity = 214, + OverageUsageQuantity = 106, + ComponentId = 176, + ComponentHandle = "component_handle4", + Memo = "memo8", + AllocationDetails = new List + { + new PrepaidUsageAllocationDetail + { + }, + }, + } +); +``` + +## DunningStepReached + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromDunningStepReached( + new DunningStepReached + { + Dunner = new DunnerData + { + State = "state8", + SubscriptionId = 194, + RevenueAtRiskInCents = 98L, + CreatedAt = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Attempts = 42, + LastAttemptedAt = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + }, + CurrentStep = new DunningStepData + { + DayThreshold = 198, + Action = "action4", + SendEmail = false, + SendBccEmail = false, + SendSms = false, + }, + NextStep = new DunningStepData + { + DayThreshold = 30, + Action = "action4", + SendEmail = false, + SendBccEmail = false, + SendSms = false, + }, + } +); +``` + +## InvoiceIssued + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromInvoiceIssued( + new InvoiceIssued + { + Uid = "uid4", + Number = "number8", + Role = "role2", + DueDate = DateTime.Parse("2016-03-13"), + IssueDate = "issue_date0", + PaidDate = "paid_date6", + DueAmount = "due_amount6", + PaidAmount = "paid_amount4", + TaxAmount = "tax_amount2", + RefundAmount = "refund_amount0", + TotalAmount = "total_amount0", + StatusAmount = "status_amount4", + ProductName = "product_name0", + ConsolidationLevel = "consolidation_level4", + LineItems = new List + { + new InvoiceLineItemEventData + { + }, + }, + } +); +``` + +## PendingCancellationChange + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPendingCancellationChange( + new PendingCancellationChange + { + CancellationState = "cancellation_state8", + CancelsAt = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + } +); +``` + +## PrepaidSubscriptionBalanceChanged + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPrepaidSubscriptionBalanceChanged( + new PrepaidSubscriptionBalanceChanged + { + Reason = "reason8", + CurrentAccountBalanceInCents = 250L, + PrepaymentAccountBalanceInCents = 44L, + CurrentUsageAmountInCents = 242L, + } +); +``` + +## ProformaInvoiceIssued + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromProformaInvoiceIssued( + new ProformaInvoiceIssued + { + Uid = "uid0", + Number = "number2", + Role = "role6", + DeliveryDate = DateTime.Parse("2016-03-13"), + CreatedAt = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + DueAmount = "due_amount2", + PaidAmount = "paid_amount8", + TaxAmount = "tax_amount6", + TotalAmount = "total_amount6", + ProductName = "product_name6", + LineItems = new List + { + new InvoiceLineItemEventData + { + }, + }, + } +); +``` + +## SubscriptionGroupSignupEventData + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromSubscriptionGroupSignupEventData( + new SubscriptionGroupSignupEventData + { + SubscriptionGroup = new SubscriptionGroupSignupFailureData + { + }, + Customer = new Customer + { + }, + } +); +``` + +## CreditAccountBalanceChanged + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromCreditAccountBalanceChanged( + new CreditAccountBalanceChanged + { + Reason = "reason8", + ServiceCreditAccountBalanceInCents = 10L, + ServiceCreditBalanceChangeInCents = 116L, + CurrencyCode = "currency_code8", + AtTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + } +); +``` + +## PrepaymentAccountBalanceChanged + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPrepaymentAccountBalanceChanged( + new PrepaymentAccountBalanceChanged + { + Reason = "reason4", + PrepaymentAccountBalanceInCents = 182L, + PrepaymentBalanceChangeInCents = 206L, + CurrencyCode = "currency_code4", + } +); +``` + +## PaymentCollectionMethodChanged + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromPaymentCollectionMethodChanged( + new PaymentCollectionMethodChanged + { + PreviousValue = "previous_value4", + CurrentValue = "current_value2", + } +); +``` + +## ItemPricePointChanged + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromItemPricePointChanged( + new ItemPricePointChanged + { + ItemId = 66, + ItemType = "item_type6", + ItemHandle = "item_handle4", + ItemName = "item_name8", + PreviousPricePoint = new ItemPricePointData + { + }, + CurrentPricePoint = new ItemPricePointData + { + }, + } +); +``` + +## CustomFieldValueChange + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromCustomFieldValueChange( + new CustomFieldValueChange + { + EventType = "event_type2", + MetafieldName = "metafield_name6", + MetafieldId = 78, + OldValue = "old_value2", + NewValue = "new_value8", + ResourceType = "resource_type2", + ResourceId = 74, + } +); +``` + +## ChjsTokenizationSuccess + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromChjsTokenizationSuccess( + new ChjsTokenizationSuccess + { + PaymentProfile = new TokenizedPaymentProfile + { + Id = 44, + }, + } +); +``` + +## ChjsTokenizationFailure + +### Initialization Code + +#### Example + +```csharp +EventEventSpecificData value = EventEventSpecificData.FromChjsTokenizationFailure( + new ChjsTokenizationFailure + { + Errors = "errors2", + } +); +``` diff --git a/doc/models/containers/invoice-event-payment.md b/doc/models/containers/invoice-event-payment.md index 3033fff3..f592c9cb 100644 --- a/doc/models/containers/invoice-event-payment.md +++ b/doc/models/containers/invoice-event-payment.md @@ -1,6 +1,8 @@ # Invoice Event Payment +A nested data structure detailing the method of payment + ## Class Name `InvoiceEventPayment` @@ -15,3 +17,86 @@ | [`PaymentMethodExternal`](../../../doc/models/payment-method-external.md) | InvoiceEventPayment.FromPaymentMethodExternal(PaymentMethodExternal paymentMethodExternal) | | [`PaymentMethodPaypal`](../../../doc/models/payment-method-paypal.md) | InvoiceEventPayment.FromPaymentMethodPaypal(PaymentMethodPaypal paymentMethodPaypal) | +## PaymentMethodApplePay + +### Initialization Code + +#### Example + +```csharp +InvoiceEventPayment value = InvoiceEventPayment.FromPaymentMethodApplePay( + new PaymentMethodApplePay + { + Type = InvoiceEventPaymentMethod.ApplePay, + } +); +``` + +## PaymentMethodBankAccount + +### Initialization Code + +#### Example + +```csharp +InvoiceEventPayment value = InvoiceEventPayment.FromPaymentMethodBankAccount( + new PaymentMethodBankAccount + { + MaskedAccountNumber = "masked_account_number2", + MaskedRoutingNumber = "masked_routing_number2", + Type = InvoiceEventPaymentMethod.BankAccount, + } +); +``` + +## PaymentMethodCreditCard + +### Initialization Code + +#### Example + +```csharp +InvoiceEventPayment value = InvoiceEventPayment.FromPaymentMethodCreditCard( + new PaymentMethodCreditCard + { + CardBrand = "card_brand4", + MaskedCardNumber = "masked_card_number0", + Type = InvoiceEventPaymentMethod.CreditCard, + } +); +``` + +## PaymentMethodExternal + +### Initialization Code + +#### Example + +```csharp +InvoiceEventPayment value = InvoiceEventPayment.FromPaymentMethodExternal( + new PaymentMethodExternal + { + Details = "details4", + Kind = "kind2", + Memo = "memo8", + Type = InvoiceEventPaymentMethod.External, + } +); +``` + +## PaymentMethodPaypal + +### Initialization Code + +#### Example + +```csharp +InvoiceEventPayment value = InvoiceEventPayment.FromPaymentMethodPaypal( + new PaymentMethodPaypal + { + Email = "email2", + Type = InvoiceEventPaymentMethod.PaypalAccount, + } +); +``` + diff --git a/doc/models/containers/invoice-event.md b/doc/models/containers/invoice-event.md index ad8b5386..d32d62b2 100644 --- a/doc/models/containers/invoice-event.md +++ b/doc/models/containers/invoice-event.md @@ -25,3 +25,519 @@ | [`VoidInvoiceEvent`](../../../doc/models/void-invoice-event.md) | InvoiceEvent.FromVoidInvoiceEvent(VoidInvoiceEvent voidInvoiceEvent) | | [`VoidRemainderEvent`](../../../doc/models/void-remainder-event.md) | InvoiceEvent.FromVoidRemainderEvent(VoidRemainderEvent voidRemainderEvent) | +## ApplyCreditNoteEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromApplyCreditNoteEvent( + new ApplyCreditNoteEvent + { + Id = 214L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ApplyCreditNote, + EventData = new ApplyCreditNoteEventData + { + Uid = "uid6", + CreditNoteNumber = "credit_note_number0", + CreditNoteUid = "credit_note_uid0", + OriginalAmount = "original_amount0", + AppliedAmount = "applied_amount2", + }, + } +); +``` + +## ApplyDebitNoteEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromApplyDebitNoteEvent( + new ApplyDebitNoteEvent + { + Id = 164L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ApplyDebitNote, + EventData = new ApplyDebitNoteEventData + { + DebitNoteNumber = "debit_note_number6", + DebitNoteUid = "debit_note_uid2", + OriginalAmount = "original_amount0", + AppliedAmount = "applied_amount2", + }, + } +); +``` + +## ApplyPaymentEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromApplyPaymentEvent( + new ApplyPaymentEvent + { + Id = 234L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ApplyPayment, + EventData = new ApplyPaymentEventData + { + ConsolidationLevel = InvoiceConsolidationLevel.Child, + Memo = "memo0", + OriginalAmount = "original_amount0", + AppliedAmount = "applied_amount2", + TransactionTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + PaymentMethod = InvoiceEventPayment.FromPaymentMethodApplePay( + new PaymentMethodApplePay + { + Type = InvoiceEventPaymentMethod.ApplePay, + } + ), + }, + } +); +``` + +## BackportInvoiceEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromBackportInvoiceEvent( + new BackportInvoiceEvent + { + Id = 78L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.BackportInvoice, + EventData = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + } +); +``` + +## ChangeChargebackStatusEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromChangeChargebackStatusEvent( + new ChangeChargebackStatusEvent + { + Id = 214L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ChangeChargebackStatus, + EventData = new ChangeChargebackStatusEventData + { + ChargebackStatus = ChargebackStatus.Won, + }, + } +); +``` + +## ChangeInvoiceCollectionMethodEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromChangeInvoiceCollectionMethodEvent( + new ChangeInvoiceCollectionMethodEvent + { + Id = 246L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ChangeInvoiceCollectionMethod, + EventData = new ChangeInvoiceCollectionMethodEventData + { + FromCollectionMethod = "from_collection_method4", + ToCollectionMethod = "to_collection_method8", + }, + } +); +``` + +## ChangeInvoiceStatusEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromChangeInvoiceStatusEvent( + new ChangeInvoiceStatusEvent + { + Id = 92L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.ChangeInvoiceStatus, + EventData = new ChangeInvoiceStatusEventData + { + FromStatus = InvoiceStatus.Open, + ToStatus = InvoiceStatus.Pending, + }, + } +); +``` + +## CreateCreditNoteEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromCreateCreditNoteEvent( + new CreateCreditNoteEvent + { + Id = 28L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.CreateCreditNote, + EventData = new CreditNote + { + }, + } +); +``` + +## CreateDebitNoteEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromCreateDebitNoteEvent( + new CreateDebitNoteEvent + { + Id = 98L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.CreateDebitNote, + EventData = new DebitNote + { + }, + } +); +``` + +## FailedPaymentEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromFailedPaymentEvent( + new FailedPaymentEvent + { + Id = 120L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.FailedPayment, + EventData = new FailedPaymentEventData + { + AmountInCents = 220, + AppliedAmount = 194, + PaymentMethod = InvoicePaymentMethodType.Cash, + TransactionId = 78, + }, + } +); +``` + +## IssueInvoiceEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromIssueInvoiceEvent( + new IssueInvoiceEvent + { + Id = 130L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.IssueInvoice, + EventData = new IssueInvoiceEventData + { + ConsolidationLevel = InvoiceConsolidationLevel.Child, + FromStatus = InvoiceStatus.Open, + ToStatus = InvoiceStatus.Pending, + DueAmount = "due_amount8", + TotalAmount = "total_amount2", + }, + } +); +``` + +## RefundInvoiceEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromRefundInvoiceEvent( + new RefundInvoiceEvent + { + Id = 54L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.RefundInvoice, + EventData = new RefundInvoiceEventData + { + ApplyCredit = false, + CreditNoteAttributes = new CreditNote + { + }, + PaymentId = 204, + RefundAmount = "refund_amount8", + RefundId = 248, + TransactionTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + }, + } +); +``` + +## RemovePaymentEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromRemovePaymentEvent( + new RemovePaymentEvent + { + Id = 236L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.RemovePayment, + EventData = new RemovePaymentEventData + { + TransactionId = 78, + Memo = "memo0", + AppliedAmount = "applied_amount2", + TransactionTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + PaymentMethod = InvoiceEventPayment.FromPaymentMethodApplePay( + new PaymentMethodApplePay + { + Type = InvoiceEventPaymentMethod.ApplePay, + } + ), + Prepayment = false, + }, + } +); +``` + +## VoidInvoiceEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromVoidInvoiceEvent( + new VoidInvoiceEvent + { + Id = 16L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.VoidInvoice, + EventData = new VoidInvoiceEventData + { + CreditNoteAttributes = new CreditNote + { + }, + Memo = "memo0", + AppliedAmount = "applied_amount2", + TransactionTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + IsAdvanceInvoice = false, + Reason = "reason2", + }, + } +); +``` + +## VoidRemainderEvent + +### Initialization Code + +#### Example + +```csharp +InvoiceEvent value = InvoiceEvent.FromVoidRemainderEvent( + new VoidRemainderEvent + { + Id = 128L, + Timestamp = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + Invoice = new Invoice + { + IssueDate = DateTime.Parse("2024-01-01"), + DueDate = DateTime.Parse("2024-01-01"), + PaidDate = DateTime.Parse("2024-01-01"), + PublicUrlExpiresOn = DateTime.Parse("2024-01-21"), + }, + EventType = InvoiceEventType.VoidRemainder, + EventData = new VoidRemainderEventData + { + CreditNoteAttributes = new CreditNote + { + }, + Memo = "memo0", + AppliedAmount = "applied_amount2", + TransactionTime = DateTime.ParseExact("2016-03-13T12:52:32.123Z", "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK", + provider: CultureInfo.InvariantCulture, + DateTimeStyles.RoundtripKind), + }, + } +); +``` + diff --git a/doc/models/containers/issue-service-credit-amount.md b/doc/models/containers/issue-service-credit-amount.md index 2b0108b3..ada28197 100644 --- a/doc/models/containers/issue-service-credit-amount.md +++ b/doc/models/containers/issue-service-credit-amount.md @@ -12,3 +12,23 @@ | `double` | IssueServiceCreditAmount.FromPrecision(double precision) | | `string` | IssueServiceCreditAmount.FromString(string mString) | +## double + +### Initialization Code + +#### Example + +```csharp +IssueServiceCreditAmount value = IssueServiceCreditAmount.FromPrecision(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +IssueServiceCreditAmount value = IssueServiceCreditAmount.FromString("String0"); +``` + diff --git a/doc/models/containers/list-product-price-points-input-product-id.md b/doc/models/containers/list-product-price-points-input-product-id.md index 39b2366d..157b20ce 100644 --- a/doc/models/containers/list-product-price-points-input-product-id.md +++ b/doc/models/containers/list-product-price-points-input-product-id.md @@ -12,3 +12,23 @@ | `int` | ListProductPricePointsInputProductId.FromNumber(int number) | | `string` | ListProductPricePointsInputProductId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ListProductPricePointsInputProductId value = ListProductPricePointsInputProductId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ListProductPricePointsInputProductId value = ListProductPricePointsInputProductId.FromString("String0"); +``` + diff --git a/doc/models/containers/list-usages-input-component-id.md b/doc/models/containers/list-usages-input-component-id.md index 1eb59d33..cd4d9b84 100644 --- a/doc/models/containers/list-usages-input-component-id.md +++ b/doc/models/containers/list-usages-input-component-id.md @@ -12,3 +12,23 @@ | `int` | ListUsagesInputComponentId.FromNumber(int number) | | `string` | ListUsagesInputComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ListUsagesInputComponentId value = ListUsagesInputComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ListUsagesInputComponentId value = ListUsagesInputComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/list-usages-input-subscription-id-or-reference.md b/doc/models/containers/list-usages-input-subscription-id-or-reference.md index ca67d065..e47b4415 100644 --- a/doc/models/containers/list-usages-input-subscription-id-or-reference.md +++ b/doc/models/containers/list-usages-input-subscription-id-or-reference.md @@ -12,3 +12,23 @@ | `int` | ListUsagesInputSubscriptionIdOrReference.FromNumber(int number) | | `string` | ListUsagesInputSubscriptionIdOrReference.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ListUsagesInputSubscriptionIdOrReference value = ListUsagesInputSubscriptionIdOrReference.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ListUsagesInputSubscriptionIdOrReference value = ListUsagesInputSubscriptionIdOrReference.FromString("String0"); +``` + diff --git a/doc/models/containers/metafield-enum.md b/doc/models/containers/metafield-enum.md index 2b3d3d40..73abc48b 100644 --- a/doc/models/containers/metafield-enum.md +++ b/doc/models/containers/metafield-enum.md @@ -12,3 +12,28 @@ | `string` | MetafieldEnum.FromString(string mString) | | `List` | MetafieldEnum.FromListOfString(List listOfString) | +## string + +### Initialization Code + +#### Example + +```csharp +MetafieldEnum value = MetafieldEnum.FromString("String0"); +``` + +## List + +### Initialization Code + +#### Example + +```csharp +MetafieldEnum value = MetafieldEnum.FromListOfString( + new List + { + "String1", + } +); +``` + diff --git a/doc/models/containers/metered-component-unit-price.md b/doc/models/containers/metered-component-unit-price.md index aac5a22f..50370910 100644 --- a/doc/models/containers/metered-component-unit-price.md +++ b/doc/models/containers/metered-component-unit-price.md @@ -12,3 +12,23 @@ | `string` | MeteredComponentUnitPrice.FromString(string mString) | | `double` | MeteredComponentUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +MeteredComponentUnitPrice value = MeteredComponentUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +MeteredComponentUnitPrice value = MeteredComponentUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/on-off-component-unit-price.md b/doc/models/containers/on-off-component-unit-price.md index a0653546..f93078ed 100644 --- a/doc/models/containers/on-off-component-unit-price.md +++ b/doc/models/containers/on-off-component-unit-price.md @@ -12,3 +12,23 @@ | `string` | OnOffComponentUnitPrice.FromString(string mString) | | `double` | OnOffComponentUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +OnOffComponentUnitPrice value = OnOffComponentUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +OnOffComponentUnitPrice value = OnOffComponentUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/payment-profile-attributes-expiration-month.md b/doc/models/containers/payment-profile-attributes-expiration-month.md index 9565b5f9..09cc7cdd 100644 --- a/doc/models/containers/payment-profile-attributes-expiration-month.md +++ b/doc/models/containers/payment-profile-attributes-expiration-month.md @@ -12,3 +12,23 @@ | `int` | PaymentProfileAttributesExpirationMonth.FromNumber(int number) | | `string` | PaymentProfileAttributesExpirationMonth.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +PaymentProfileAttributesExpirationMonth value = PaymentProfileAttributesExpirationMonth.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +PaymentProfileAttributesExpirationMonth value = PaymentProfileAttributesExpirationMonth.FromString("String0"); +``` + diff --git a/doc/models/containers/payment-profile-attributes-expiration-year.md b/doc/models/containers/payment-profile-attributes-expiration-year.md index e8ef1909..ac2e33bb 100644 --- a/doc/models/containers/payment-profile-attributes-expiration-year.md +++ b/doc/models/containers/payment-profile-attributes-expiration-year.md @@ -12,3 +12,23 @@ | `int` | PaymentProfileAttributesExpirationYear.FromNumber(int number) | | `string` | PaymentProfileAttributesExpirationYear.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +PaymentProfileAttributesExpirationYear value = PaymentProfileAttributesExpirationYear.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +PaymentProfileAttributesExpirationYear value = PaymentProfileAttributesExpirationYear.FromString("String0"); +``` + diff --git a/doc/models/containers/payment-profile.md b/doc/models/containers/payment-profile.md index 7b94d4fa..14667bc7 100644 --- a/doc/models/containers/payment-profile.md +++ b/doc/models/containers/payment-profile.md @@ -14,3 +14,83 @@ | [`CreditCardPaymentProfile`](../../../doc/models/credit-card-payment-profile.md) | PaymentProfile.FromCreditCardPaymentProfile(CreditCardPaymentProfile creditCardPaymentProfile) | | [`PaypalPaymentProfile`](../../../doc/models/paypal-payment-profile.md) | PaymentProfile.FromPaypalPaymentProfile(PaypalPaymentProfile paypalPaymentProfile) | +## ApplePayPaymentProfile + +### Initialization Code + +#### Example + +```csharp +PaymentProfile value = PaymentProfile.FromApplePayPaymentProfile( + new ApplePayPaymentProfile + { + PaymentType = PaymentType.ApplePay, + } +); +``` + +## BankAccountPaymentProfile + +### Initialization Code + +#### Example + +```csharp +PaymentProfile value = PaymentProfile.FromBankAccountPaymentProfile( + new BankAccountPaymentProfile + { + PaymentType = PaymentType.BankAccount, + Verified = false, + } +); +``` + +## CreditCardPaymentProfile + +### Initialization Code + +#### Example + +```csharp +PaymentProfile value = PaymentProfile.FromCreditCardPaymentProfile( + new CreditCardPaymentProfile + { + PaymentType = PaymentType.CreditCard, + Id = 10088716, + FirstName = "Test", + LastName = "Subscription", + MaskedCardNumber = "XXXX-XXXX-XXXX-1", + CardType = CardType.Bogus, + ExpirationMonth = 1, + ExpirationYear = 2022, + CustomerId = 14543792, + CurrentVault = CreditCardVault.Bogus, + VaultToken = "1", + BillingAddress = "123 Montana Way", + BillingCity = "Billings", + BillingState = "MT", + BillingZip = "59101", + BillingCountry = "US", + CustomerVaultToken = "customer_vault_token2", + BillingAddress2 = "", + SiteGatewaySettingId = 1, + GatewayHandle = "gateway_handle8", + } +); +``` + +## PaypalPaymentProfile + +### Initialization Code + +#### Example + +```csharp +PaymentProfile value = PaymentProfile.FromPaypalPaymentProfile( + new PaypalPaymentProfile + { + PaymentType = PaymentType.PaypalAccount, + } +); +``` + diff --git a/doc/models/containers/prepaid-usage-component-unit-price.md b/doc/models/containers/prepaid-usage-component-unit-price.md index db300f2b..5925498d 100644 --- a/doc/models/containers/prepaid-usage-component-unit-price.md +++ b/doc/models/containers/prepaid-usage-component-unit-price.md @@ -12,3 +12,23 @@ | `string` | PrepaidUsageComponentUnitPrice.FromString(string mString) | | `double` | PrepaidUsageComponentUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +PrepaidUsageComponentUnitPrice value = PrepaidUsageComponentUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +PrepaidUsageComponentUnitPrice value = PrepaidUsageComponentUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/price-ending-quantity.md b/doc/models/containers/price-ending-quantity.md index cd5c1a53..5824882b 100644 --- a/doc/models/containers/price-ending-quantity.md +++ b/doc/models/containers/price-ending-quantity.md @@ -12,3 +12,23 @@ | `int` | PriceEndingQuantity.FromNumber(int number) | | `string` | PriceEndingQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +PriceEndingQuantity value = PriceEndingQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +PriceEndingQuantity value = PriceEndingQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/price-starting-quantity.md b/doc/models/containers/price-starting-quantity.md index e9306b2f..c23054d6 100644 --- a/doc/models/containers/price-starting-quantity.md +++ b/doc/models/containers/price-starting-quantity.md @@ -12,3 +12,23 @@ | `int` | PriceStartingQuantity.FromNumber(int number) | | `string` | PriceStartingQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +PriceStartingQuantity value = PriceStartingQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +PriceStartingQuantity value = PriceStartingQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/price-unit-price.md b/doc/models/containers/price-unit-price.md index 93bcf09c..d676487b 100644 --- a/doc/models/containers/price-unit-price.md +++ b/doc/models/containers/price-unit-price.md @@ -12,3 +12,23 @@ | `double` | PriceUnitPrice.FromPrecision(double precision) | | `string` | PriceUnitPrice.FromString(string mString) | +## double + +### Initialization Code + +#### Example + +```csharp +PriceUnitPrice value = PriceUnitPrice.FromPrecision(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +PriceUnitPrice value = PriceUnitPrice.FromString("String0"); +``` + diff --git a/doc/models/containers/quantity-based-component-unit-price.md b/doc/models/containers/quantity-based-component-unit-price.md index acf74693..f5e77605 100644 --- a/doc/models/containers/quantity-based-component-unit-price.md +++ b/doc/models/containers/quantity-based-component-unit-price.md @@ -12,3 +12,23 @@ | `string` | QuantityBasedComponentUnitPrice.FromString(string mString) | | `double` | QuantityBasedComponentUnitPrice.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +QuantityBasedComponentUnitPrice value = QuantityBasedComponentUnitPrice.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +QuantityBasedComponentUnitPrice value = QuantityBasedComponentUnitPrice.FromPrecision(0); +``` + diff --git a/doc/models/containers/reactivate-subscription-request-resume.md b/doc/models/containers/reactivate-subscription-request-resume.md index 97454e0d..cb60fb19 100644 --- a/doc/models/containers/reactivate-subscription-request-resume.md +++ b/doc/models/containers/reactivate-subscription-request-resume.md @@ -12,3 +12,27 @@ | `bool` | ReactivateSubscriptionRequestResume.FromBoolean(bool boolean) | | [`ResumeOptions`](../../../doc/models/resume-options.md) | ReactivateSubscriptionRequestResume.FromResumeOptions(ResumeOptions resumeOptions) | +## bool + +### Initialization Code + +#### Example + +```csharp +ReactivateSubscriptionRequestResume value = ReactivateSubscriptionRequestResume.FromBoolean(false); +``` + +## ResumeOptions + +### Initialization Code + +#### Example + +```csharp +ReactivateSubscriptionRequestResume value = ReactivateSubscriptionRequestResume.FromResumeOptions( + new ResumeOptions + { + } +); +``` + diff --git a/doc/models/containers/read-component-price-point-component-id.md b/doc/models/containers/read-component-price-point-component-id.md index 46c5f11d..4cbf6378 100644 --- a/doc/models/containers/read-component-price-point-component-id.md +++ b/doc/models/containers/read-component-price-point-component-id.md @@ -12,3 +12,23 @@ | `int` | ReadComponentPricePointComponentId.FromNumber(int number) | | `string` | ReadComponentPricePointComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ReadComponentPricePointComponentId value = ReadComponentPricePointComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ReadComponentPricePointComponentId value = ReadComponentPricePointComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/read-component-price-point-price-point-id.md b/doc/models/containers/read-component-price-point-price-point-id.md index e820814f..7bd88afb 100644 --- a/doc/models/containers/read-component-price-point-price-point-id.md +++ b/doc/models/containers/read-component-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | ReadComponentPricePointPricePointId.FromNumber(int number) | | `string` | ReadComponentPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ReadComponentPricePointPricePointId value = ReadComponentPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ReadComponentPricePointPricePointId value = ReadComponentPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/read-product-price-point-price-point-id.md b/doc/models/containers/read-product-price-point-price-point-id.md index 73e9dbb0..024d4612 100644 --- a/doc/models/containers/read-product-price-point-price-point-id.md +++ b/doc/models/containers/read-product-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | ReadProductPricePointPricePointId.FromNumber(int number) | | `string` | ReadProductPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ReadProductPricePointPricePointId value = ReadProductPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ReadProductPricePointPricePointId value = ReadProductPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/read-product-price-point-product-id.md b/doc/models/containers/read-product-price-point-product-id.md index ae10518c..bb677fe1 100644 --- a/doc/models/containers/read-product-price-point-product-id.md +++ b/doc/models/containers/read-product-price-point-product-id.md @@ -12,3 +12,23 @@ | `int` | ReadProductPricePointProductId.FromNumber(int number) | | `string` | ReadProductPricePointProductId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +ReadProductPricePointProductId value = ReadProductPricePointProductId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +ReadProductPricePointProductId value = ReadProductPricePointProductId.FromString("String0"); +``` + diff --git a/doc/models/containers/refund-consolidated-invoice-segment-uids.md b/doc/models/containers/refund-consolidated-invoice-segment-uids.md index 80c85edc..36e89ab8 100644 --- a/doc/models/containers/refund-consolidated-invoice-segment-uids.md +++ b/doc/models/containers/refund-consolidated-invoice-segment-uids.md @@ -12,3 +12,28 @@ | `List` | RefundConsolidatedInvoiceSegmentUids.FromListOfString(List listOfString) | | `string` | RefundConsolidatedInvoiceSegmentUids.FromString(string mString) | +## List + +### Initialization Code + +#### Example + +```csharp +RefundConsolidatedInvoiceSegmentUids value = RefundConsolidatedInvoiceSegmentUids.FromListOfString( + new List + { + "String1", + } +); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +RefundConsolidatedInvoiceSegmentUids value = RefundConsolidatedInvoiceSegmentUids.FromString("String0"); +``` + diff --git a/doc/models/containers/refund-invoice-request-refund.md b/doc/models/containers/refund-invoice-request-refund.md index 941b423d..a8d814ab 100644 --- a/doc/models/containers/refund-invoice-request-refund.md +++ b/doc/models/containers/refund-invoice-request-refund.md @@ -12,3 +12,43 @@ | [`RefundInvoice`](../../../doc/models/refund-invoice.md) | RefundInvoiceRequestRefund.FromRefundInvoice(RefundInvoice refundInvoice) | | [`RefundConsolidatedInvoice`](../../../doc/models/refund-consolidated-invoice.md) | RefundInvoiceRequestRefund.FromRefundConsolidatedInvoice(RefundConsolidatedInvoice refundConsolidatedInvoice) | +## RefundInvoice + +### Initialization Code + +#### Example + +```csharp +RefundInvoiceRequestRefund value = RefundInvoiceRequestRefund.FromRefundInvoice( + new RefundInvoice + { + Amount = "amount8", + Memo = "memo0", + PaymentId = 0, + } +); +``` + +## RefundConsolidatedInvoice + +### Initialization Code + +#### Example + +```csharp +RefundInvoiceRequestRefund value = RefundInvoiceRequestRefund.FromRefundConsolidatedInvoice( + new RefundConsolidatedInvoice + { + Memo = "memo0", + PaymentId = 46, + SegmentUids = RefundConsolidatedInvoiceSegmentUids.FromListOfString( + new List + { + "String0", + "String1", + } + ), + } +); +``` + diff --git a/doc/models/containers/refund-prepayment-amount.md b/doc/models/containers/refund-prepayment-amount.md index 03858c4c..97672c9b 100644 --- a/doc/models/containers/refund-prepayment-amount.md +++ b/doc/models/containers/refund-prepayment-amount.md @@ -12,3 +12,23 @@ | `string` | RefundPrepaymentAmount.FromString(string mString) | | `double` | RefundPrepaymentAmount.FromPrecision(double precision) | +## string + +### Initialization Code + +#### Example + +```csharp +RefundPrepaymentAmount value = RefundPrepaymentAmount.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +RefundPrepaymentAmount value = RefundPrepaymentAmount.FromPrecision(0); +``` + diff --git a/doc/models/containers/renewal-preview-component-component-id.md b/doc/models/containers/renewal-preview-component-component-id.md index 77dd5b24..a3111b76 100644 --- a/doc/models/containers/renewal-preview-component-component-id.md +++ b/doc/models/containers/renewal-preview-component-component-id.md @@ -12,3 +12,23 @@ | `string` | RenewalPreviewComponentComponentId.FromString(string mString) | | `int` | RenewalPreviewComponentComponentId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +RenewalPreviewComponentComponentId value = RenewalPreviewComponentComponentId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +RenewalPreviewComponentComponentId value = RenewalPreviewComponentComponentId.FromNumber(0); +``` + diff --git a/doc/models/containers/renewal-preview-component-price-point-id.md b/doc/models/containers/renewal-preview-component-price-point-id.md index 000297f7..33087609 100644 --- a/doc/models/containers/renewal-preview-component-price-point-id.md +++ b/doc/models/containers/renewal-preview-component-price-point-id.md @@ -12,3 +12,23 @@ | `string` | RenewalPreviewComponentPricePointId.FromString(string mString) | | `int` | RenewalPreviewComponentPricePointId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +RenewalPreviewComponentPricePointId value = RenewalPreviewComponentPricePointId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +RenewalPreviewComponentPricePointId value = RenewalPreviewComponentPricePointId.FromNumber(0); +``` + diff --git a/doc/models/containers/scheduled-renewal-configuration-item-request-renewal-configuration-item.md b/doc/models/containers/scheduled-renewal-configuration-item-request-renewal-configuration-item.md index f9865cfa..8dd9e6bf 100644 --- a/doc/models/containers/scheduled-renewal-configuration-item-request-renewal-configuration-item.md +++ b/doc/models/containers/scheduled-renewal-configuration-item-request-renewal-configuration-item.md @@ -12,3 +12,35 @@ | [`ScheduledRenewalItemRequestBodyComponent`](../../../doc/models/scheduled-renewal-item-request-body-component.md) | ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyComponent(ScheduledRenewalItemRequestBodyComponent scheduledRenewalItemRequestBodyComponent) | | [`ScheduledRenewalItemRequestBodyProduct`](../../../doc/models/scheduled-renewal-item-request-body-product.md) | ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyProduct(ScheduledRenewalItemRequestBodyProduct scheduledRenewalItemRequestBodyProduct) | +## ScheduledRenewalItemRequestBodyComponent + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem value = ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyComponent( + new ScheduledRenewalItemRequestBodyComponent + { + ItemType = "Component", + ItemId = 108, + } +); +``` + +## ScheduledRenewalItemRequestBodyProduct + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem value = ScheduledRenewalConfigurationItemRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyProduct( + new ScheduledRenewalItemRequestBodyProduct + { + ItemType = "Product", + ItemId = 32, + } +); +``` + diff --git a/doc/models/containers/scheduled-renewal-product-price-point-interval.md b/doc/models/containers/scheduled-renewal-product-price-point-interval.md index 7d3e45c6..e51dab37 100644 --- a/doc/models/containers/scheduled-renewal-product-price-point-interval.md +++ b/doc/models/containers/scheduled-renewal-product-price-point-interval.md @@ -12,3 +12,23 @@ | `string` | ScheduledRenewalProductPricePointInterval.FromString(string mString) | | `int` | ScheduledRenewalProductPricePointInterval.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalProductPricePointInterval value = ScheduledRenewalProductPricePointInterval.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalProductPricePointInterval value = ScheduledRenewalProductPricePointInterval.FromNumber(0); +``` + diff --git a/doc/models/containers/scheduled-renewal-product-price-point-price-in-cents.md b/doc/models/containers/scheduled-renewal-product-price-point-price-in-cents.md index 1f3c01a4..e8cc6b84 100644 --- a/doc/models/containers/scheduled-renewal-product-price-point-price-in-cents.md +++ b/doc/models/containers/scheduled-renewal-product-price-point-price-in-cents.md @@ -12,3 +12,23 @@ | `string` | ScheduledRenewalProductPricePointPriceInCents.FromString(string mString) | | `long` | ScheduledRenewalProductPricePointPriceInCents.FromLong(long mLong) | +## string + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalProductPricePointPriceInCents value = ScheduledRenewalProductPricePointPriceInCents.FromString("String0"); +``` + +## long + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalProductPricePointPriceInCents value = ScheduledRenewalProductPricePointPriceInCents.FromLong(0L); +``` + diff --git a/doc/models/containers/scheduled-renewal-update-request-renewal-configuration-item.md b/doc/models/containers/scheduled-renewal-update-request-renewal-configuration-item.md index 9ca724a5..791b9b63 100644 --- a/doc/models/containers/scheduled-renewal-update-request-renewal-configuration-item.md +++ b/doc/models/containers/scheduled-renewal-update-request-renewal-configuration-item.md @@ -12,3 +12,35 @@ | [`ScheduledRenewalItemRequestBodyComponent`](../../../doc/models/scheduled-renewal-item-request-body-component.md) | ScheduledRenewalUpdateRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyComponent(ScheduledRenewalItemRequestBodyComponent scheduledRenewalItemRequestBodyComponent) | | [`ScheduledRenewalItemRequestBodyProduct`](../../../doc/models/scheduled-renewal-item-request-body-product.md) | ScheduledRenewalUpdateRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyProduct(ScheduledRenewalItemRequestBodyProduct scheduledRenewalItemRequestBodyProduct) | +## ScheduledRenewalItemRequestBodyComponent + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalUpdateRequestRenewalConfigurationItem value = ScheduledRenewalUpdateRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyComponent( + new ScheduledRenewalItemRequestBodyComponent + { + ItemType = "Component", + ItemId = 108, + } +); +``` + +## ScheduledRenewalItemRequestBodyProduct + +### Initialization Code + +#### Example + +```csharp +ScheduledRenewalUpdateRequestRenewalConfigurationItem value = ScheduledRenewalUpdateRequestRenewalConfigurationItem.FromScheduledRenewalItemRequestBodyProduct( + new ScheduledRenewalItemRequestBodyProduct + { + ItemType = "Product", + ItemId = 32, + } +); +``` + diff --git a/doc/models/containers/segment-segment-property-1-value.md b/doc/models/containers/segment-segment-property-1-value.md index 349aae62..2c5fa656 100644 --- a/doc/models/containers/segment-segment-property-1-value.md +++ b/doc/models/containers/segment-segment-property-1-value.md @@ -14,3 +14,43 @@ | `int` | SegmentSegmentProperty1Value.FromNumber(int number) | | `bool` | SegmentSegmentProperty1Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty1Value value = SegmentSegmentProperty1Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty1Value value = SegmentSegmentProperty1Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty1Value value = SegmentSegmentProperty1Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty1Value value = SegmentSegmentProperty1Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/segment-segment-property-2-value.md b/doc/models/containers/segment-segment-property-2-value.md index c5a8a482..b2df8c87 100644 --- a/doc/models/containers/segment-segment-property-2-value.md +++ b/doc/models/containers/segment-segment-property-2-value.md @@ -14,3 +14,43 @@ | `int` | SegmentSegmentProperty2Value.FromNumber(int number) | | `bool` | SegmentSegmentProperty2Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty2Value value = SegmentSegmentProperty2Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty2Value value = SegmentSegmentProperty2Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty2Value value = SegmentSegmentProperty2Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty2Value value = SegmentSegmentProperty2Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/segment-segment-property-3-value.md b/doc/models/containers/segment-segment-property-3-value.md index 6f4a69f1..320bfef2 100644 --- a/doc/models/containers/segment-segment-property-3-value.md +++ b/doc/models/containers/segment-segment-property-3-value.md @@ -14,3 +14,43 @@ | `int` | SegmentSegmentProperty3Value.FromNumber(int number) | | `bool` | SegmentSegmentProperty3Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty3Value value = SegmentSegmentProperty3Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty3Value value = SegmentSegmentProperty3Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty3Value value = SegmentSegmentProperty3Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty3Value value = SegmentSegmentProperty3Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/segment-segment-property-4-value.md b/doc/models/containers/segment-segment-property-4-value.md index e8310109..1edf5aa4 100644 --- a/doc/models/containers/segment-segment-property-4-value.md +++ b/doc/models/containers/segment-segment-property-4-value.md @@ -14,3 +14,43 @@ | `int` | SegmentSegmentProperty4Value.FromNumber(int number) | | `bool` | SegmentSegmentProperty4Value.FromBoolean(bool boolean) | +## string + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty4Value value = SegmentSegmentProperty4Value.FromString("String0"); +``` + +## double + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty4Value value = SegmentSegmentProperty4Value.FromPrecision(0); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty4Value value = SegmentSegmentProperty4Value.FromNumber(0); +``` + +## bool + +### Initialization Code + +#### Example + +```csharp +SegmentSegmentProperty4Value value = SegmentSegmentProperty4Value.FromBoolean(false); +``` + diff --git a/doc/models/containers/subscription-component-allocated-quantity.md b/doc/models/containers/subscription-component-allocated-quantity.md index 7aedf7ab..7a77524f 100644 --- a/doc/models/containers/subscription-component-allocated-quantity.md +++ b/doc/models/containers/subscription-component-allocated-quantity.md @@ -12,3 +12,23 @@ | `int` | SubscriptionComponentAllocatedQuantity.FromNumber(int number) | | `string` | SubscriptionComponentAllocatedQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionComponentAllocatedQuantity value = SubscriptionComponentAllocatedQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionComponentAllocatedQuantity value = SubscriptionComponentAllocatedQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/subscription-custom-price-expiration-interval.md b/doc/models/containers/subscription-custom-price-expiration-interval.md index e876d321..42ff80de 100644 --- a/doc/models/containers/subscription-custom-price-expiration-interval.md +++ b/doc/models/containers/subscription-custom-price-expiration-interval.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPriceExpirationInterval.FromString(string mString) | | `int` | SubscriptionCustomPriceExpirationInterval.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceExpirationInterval value = SubscriptionCustomPriceExpirationInterval.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceExpirationInterval value = SubscriptionCustomPriceExpirationInterval.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md b/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md index 89366621..534d2156 100644 --- a/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md +++ b/doc/models/containers/subscription-custom-price-initial-charge-in-cents.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPriceInitialChargeInCents.FromString(string mString) | | `long` | SubscriptionCustomPriceInitialChargeInCents.FromLong(long mLong) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceInitialChargeInCents value = SubscriptionCustomPriceInitialChargeInCents.FromString("String0"); +``` + +## long + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceInitialChargeInCents value = SubscriptionCustomPriceInitialChargeInCents.FromLong(0L); +``` + diff --git a/doc/models/containers/subscription-custom-price-interval.md b/doc/models/containers/subscription-custom-price-interval.md index d95b9bbb..cf551787 100644 --- a/doc/models/containers/subscription-custom-price-interval.md +++ b/doc/models/containers/subscription-custom-price-interval.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPriceInterval.FromString(string mString) | | `int` | SubscriptionCustomPriceInterval.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceInterval value = SubscriptionCustomPriceInterval.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceInterval value = SubscriptionCustomPriceInterval.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-custom-price-price-in-cents.md b/doc/models/containers/subscription-custom-price-price-in-cents.md index d729f221..53378f52 100644 --- a/doc/models/containers/subscription-custom-price-price-in-cents.md +++ b/doc/models/containers/subscription-custom-price-price-in-cents.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPricePriceInCents.FromString(string mString) | | `long` | SubscriptionCustomPricePriceInCents.FromLong(long mLong) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPricePriceInCents value = SubscriptionCustomPricePriceInCents.FromString("String0"); +``` + +## long + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPricePriceInCents value = SubscriptionCustomPricePriceInCents.FromLong(0L); +``` + diff --git a/doc/models/containers/subscription-custom-price-trial-interval.md b/doc/models/containers/subscription-custom-price-trial-interval.md index 5f41d0aa..4214e0d5 100644 --- a/doc/models/containers/subscription-custom-price-trial-interval.md +++ b/doc/models/containers/subscription-custom-price-trial-interval.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPriceTrialInterval.FromString(string mString) | | `int` | SubscriptionCustomPriceTrialInterval.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceTrialInterval value = SubscriptionCustomPriceTrialInterval.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceTrialInterval value = SubscriptionCustomPriceTrialInterval.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-custom-price-trial-price-in-cents.md b/doc/models/containers/subscription-custom-price-trial-price-in-cents.md index 3d923df5..01ada471 100644 --- a/doc/models/containers/subscription-custom-price-trial-price-in-cents.md +++ b/doc/models/containers/subscription-custom-price-trial-price-in-cents.md @@ -12,3 +12,23 @@ | `string` | SubscriptionCustomPriceTrialPriceInCents.FromString(string mString) | | `long` | SubscriptionCustomPriceTrialPriceInCents.FromLong(long mLong) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceTrialPriceInCents value = SubscriptionCustomPriceTrialPriceInCents.FromString("String0"); +``` + +## long + +### Initialization Code + +#### Example + +```csharp +SubscriptionCustomPriceTrialPriceInCents value = SubscriptionCustomPriceTrialPriceInCents.FromLong(0L); +``` + diff --git a/doc/models/containers/subscription-group-create-error-response-errors.md b/doc/models/containers/subscription-group-create-error-response-errors.md index 76361a62..1b398790 100644 --- a/doc/models/containers/subscription-group-create-error-response-errors.md +++ b/doc/models/containers/subscription-group-create-error-response-errors.md @@ -13,3 +13,46 @@ | [`SubscriptionGroupSingleError`](../../../doc/models/subscription-group-single-error.md) | SubscriptionGroupCreateErrorResponseErrors.FromSubscriptionGroupSingleError(SubscriptionGroupSingleError subscriptionGroupSingleError) | | `string` | SubscriptionGroupCreateErrorResponseErrors.FromString(string mString) | +## SubscriptionGroupMembersArrayError + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreateErrorResponseErrors value = SubscriptionGroupCreateErrorResponseErrors.FromSubscriptionGroupMembersArrayError( + new SubscriptionGroupMembersArrayError + { + Members = new List + { + "members6", + }, + } +); +``` + +## SubscriptionGroupSingleError + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreateErrorResponseErrors value = SubscriptionGroupCreateErrorResponseErrors.FromSubscriptionGroupSingleError( + new SubscriptionGroupSingleError + { + SubscriptionGroup = "subscription_group2", + } +); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreateErrorResponseErrors value = SubscriptionGroupCreateErrorResponseErrors.FromString("String0"); +``` + diff --git a/doc/models/containers/subscription-group-credit-card-expiration-month.md b/doc/models/containers/subscription-group-credit-card-expiration-month.md index 5ef33616..534e3ee1 100644 --- a/doc/models/containers/subscription-group-credit-card-expiration-month.md +++ b/doc/models/containers/subscription-group-credit-card-expiration-month.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupCreditCardExpirationMonth.FromString(string mString) | | `int` | SubscriptionGroupCreditCardExpirationMonth.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardExpirationMonth value = SubscriptionGroupCreditCardExpirationMonth.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardExpirationMonth value = SubscriptionGroupCreditCardExpirationMonth.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-credit-card-expiration-year.md b/doc/models/containers/subscription-group-credit-card-expiration-year.md index c8fbdf50..528d808f 100644 --- a/doc/models/containers/subscription-group-credit-card-expiration-year.md +++ b/doc/models/containers/subscription-group-credit-card-expiration-year.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupCreditCardExpirationYear.FromString(string mString) | | `int` | SubscriptionGroupCreditCardExpirationYear.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardExpirationYear value = SubscriptionGroupCreditCardExpirationYear.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardExpirationYear value = SubscriptionGroupCreditCardExpirationYear.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-credit-card-full-number.md b/doc/models/containers/subscription-group-credit-card-full-number.md index ce4e98bc..1ced07f7 100644 --- a/doc/models/containers/subscription-group-credit-card-full-number.md +++ b/doc/models/containers/subscription-group-credit-card-full-number.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupCreditCardFullNumber.FromString(string mString) | | `int` | SubscriptionGroupCreditCardFullNumber.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardFullNumber value = SubscriptionGroupCreditCardFullNumber.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupCreditCardFullNumber value = SubscriptionGroupCreditCardFullNumber.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-signup-component-allocated-quantity.md b/doc/models/containers/subscription-group-signup-component-allocated-quantity.md index 20c652f6..42163e0d 100644 --- a/doc/models/containers/subscription-group-signup-component-allocated-quantity.md +++ b/doc/models/containers/subscription-group-signup-component-allocated-quantity.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupSignupComponentAllocatedQuantity.FromString(string mString) | | `int` | SubscriptionGroupSignupComponentAllocatedQuantity.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentAllocatedQuantity value = SubscriptionGroupSignupComponentAllocatedQuantity.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentAllocatedQuantity value = SubscriptionGroupSignupComponentAllocatedQuantity.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-signup-component-component-id.md b/doc/models/containers/subscription-group-signup-component-component-id.md index ef3c8bdf..8db76a44 100644 --- a/doc/models/containers/subscription-group-signup-component-component-id.md +++ b/doc/models/containers/subscription-group-signup-component-component-id.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupSignupComponentComponentId.FromString(string mString) | | `int` | SubscriptionGroupSignupComponentComponentId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentComponentId value = SubscriptionGroupSignupComponentComponentId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentComponentId value = SubscriptionGroupSignupComponentComponentId.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-signup-component-price-point-id.md b/doc/models/containers/subscription-group-signup-component-price-point-id.md index 20c57ec5..171a578a 100644 --- a/doc/models/containers/subscription-group-signup-component-price-point-id.md +++ b/doc/models/containers/subscription-group-signup-component-price-point-id.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupSignupComponentPricePointId.FromString(string mString) | | `int` | SubscriptionGroupSignupComponentPricePointId.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentPricePointId value = SubscriptionGroupSignupComponentPricePointId.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentPricePointId value = SubscriptionGroupSignupComponentPricePointId.FromNumber(0); +``` + diff --git a/doc/models/containers/subscription-group-signup-component-unit-balance.md b/doc/models/containers/subscription-group-signup-component-unit-balance.md index a8e0c0c3..d9a759c9 100644 --- a/doc/models/containers/subscription-group-signup-component-unit-balance.md +++ b/doc/models/containers/subscription-group-signup-component-unit-balance.md @@ -12,3 +12,23 @@ | `string` | SubscriptionGroupSignupComponentUnitBalance.FromString(string mString) | | `int` | SubscriptionGroupSignupComponentUnitBalance.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentUnitBalance value = SubscriptionGroupSignupComponentUnitBalance.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +SubscriptionGroupSignupComponentUnitBalance value = SubscriptionGroupSignupComponentUnitBalance.FromNumber(0); +``` + diff --git a/doc/models/containers/update-component-price-point-component-id.md b/doc/models/containers/update-component-price-point-component-id.md index e9f4e94d..81279652 100644 --- a/doc/models/containers/update-component-price-point-component-id.md +++ b/doc/models/containers/update-component-price-point-component-id.md @@ -12,3 +12,23 @@ | `int` | UpdateComponentPricePointComponentId.FromNumber(int number) | | `string` | UpdateComponentPricePointComponentId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdateComponentPricePointComponentId value = UpdateComponentPricePointComponentId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdateComponentPricePointComponentId value = UpdateComponentPricePointComponentId.FromString("String0"); +``` + diff --git a/doc/models/containers/update-component-price-point-price-point-id.md b/doc/models/containers/update-component-price-point-price-point-id.md index e457429d..fad0dc29 100644 --- a/doc/models/containers/update-component-price-point-price-point-id.md +++ b/doc/models/containers/update-component-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | UpdateComponentPricePointPricePointId.FromNumber(int number) | | `string` | UpdateComponentPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdateComponentPricePointPricePointId value = UpdateComponentPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdateComponentPricePointPricePointId value = UpdateComponentPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/update-metafields-request-metafields.md b/doc/models/containers/update-metafields-request-metafields.md index 91061d82..57fcfed5 100644 --- a/doc/models/containers/update-metafields-request-metafields.md +++ b/doc/models/containers/update-metafields-request-metafields.md @@ -12,3 +12,34 @@ | [`UpdateMetafield`](../../../doc/models/update-metafield.md) | UpdateMetafieldsRequestMetafields.FromUpdateMetafield(UpdateMetafield updateMetafield) | | [`List`](../../../doc/models/update-metafield.md) | UpdateMetafieldsRequestMetafields.FromListOfUpdateMetafield(List listOfUpdateMetafield) | +## UpdateMetafield + +### Initialization Code + +#### Example + +```csharp +UpdateMetafieldsRequestMetafields value = UpdateMetafieldsRequestMetafields.FromUpdateMetafield( + new UpdateMetafield + { + } +); +``` + +## List + +### Initialization Code + +#### Example + +```csharp +UpdateMetafieldsRequestMetafields value = UpdateMetafieldsRequestMetafields.FromListOfUpdateMetafield( + new List + { + new UpdateMetafield + { + }, + } +); +``` + diff --git a/doc/models/containers/update-price-ending-quantity.md b/doc/models/containers/update-price-ending-quantity.md index 32e586e2..411d6f38 100644 --- a/doc/models/containers/update-price-ending-quantity.md +++ b/doc/models/containers/update-price-ending-quantity.md @@ -12,3 +12,23 @@ | `int` | UpdatePriceEndingQuantity.FromNumber(int number) | | `string` | UpdatePriceEndingQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdatePriceEndingQuantity value = UpdatePriceEndingQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdatePriceEndingQuantity value = UpdatePriceEndingQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/update-price-starting-quantity.md b/doc/models/containers/update-price-starting-quantity.md index dc8a98ee..f844f689 100644 --- a/doc/models/containers/update-price-starting-quantity.md +++ b/doc/models/containers/update-price-starting-quantity.md @@ -12,3 +12,23 @@ | `int` | UpdatePriceStartingQuantity.FromNumber(int number) | | `string` | UpdatePriceStartingQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdatePriceStartingQuantity value = UpdatePriceStartingQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdatePriceStartingQuantity value = UpdatePriceStartingQuantity.FromString("String0"); +``` + diff --git a/doc/models/containers/update-price-unit-price.md b/doc/models/containers/update-price-unit-price.md index a3b3395f..ef92fbf2 100644 --- a/doc/models/containers/update-price-unit-price.md +++ b/doc/models/containers/update-price-unit-price.md @@ -12,3 +12,23 @@ | `double` | UpdatePriceUnitPrice.FromPrecision(double precision) | | `string` | UpdatePriceUnitPrice.FromString(string mString) | +## double + +### Initialization Code + +#### Example + +```csharp +UpdatePriceUnitPrice value = UpdatePriceUnitPrice.FromPrecision(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdatePriceUnitPrice value = UpdatePriceUnitPrice.FromString("String0"); +``` + diff --git a/doc/models/containers/update-product-price-point-price-point-id.md b/doc/models/containers/update-product-price-point-price-point-id.md index 2f490fdc..9f47505e 100644 --- a/doc/models/containers/update-product-price-point-price-point-id.md +++ b/doc/models/containers/update-product-price-point-price-point-id.md @@ -12,3 +12,23 @@ | `int` | UpdateProductPricePointPricePointId.FromNumber(int number) | | `string` | UpdateProductPricePointPricePointId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdateProductPricePointPricePointId value = UpdateProductPricePointPricePointId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdateProductPricePointPricePointId value = UpdateProductPricePointPricePointId.FromString("String0"); +``` + diff --git a/doc/models/containers/update-product-price-point-product-id.md b/doc/models/containers/update-product-price-point-product-id.md index e682eb8a..b0d07584 100644 --- a/doc/models/containers/update-product-price-point-product-id.md +++ b/doc/models/containers/update-product-price-point-product-id.md @@ -12,3 +12,23 @@ | `int` | UpdateProductPricePointProductId.FromNumber(int number) | | `string` | UpdateProductPricePointProductId.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UpdateProductPricePointProductId value = UpdateProductPricePointProductId.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UpdateProductPricePointProductId value = UpdateProductPricePointProductId.FromString("String0"); +``` + diff --git a/doc/models/containers/update-subscription-net-terms.md b/doc/models/containers/update-subscription-net-terms.md index 8b65dc0e..df1709b8 100644 --- a/doc/models/containers/update-subscription-net-terms.md +++ b/doc/models/containers/update-subscription-net-terms.md @@ -12,3 +12,23 @@ | `string` | UpdateSubscriptionNetTerms.FromString(string mString) | | `int` | UpdateSubscriptionNetTerms.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +UpdateSubscriptionNetTerms value = UpdateSubscriptionNetTerms.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +UpdateSubscriptionNetTerms value = UpdateSubscriptionNetTerms.FromNumber(0); +``` + diff --git a/doc/models/containers/update-subscription-snap-day.md b/doc/models/containers/update-subscription-snap-day.md index 6c52866f..e16c2db5 100644 --- a/doc/models/containers/update-subscription-snap-day.md +++ b/doc/models/containers/update-subscription-snap-day.md @@ -12,3 +12,23 @@ | `string` | UpdateSubscriptionSnapDay.FromString(string mString) | | `int` | UpdateSubscriptionSnapDay.FromNumber(int number) | +## string + +### Initialization Code + +#### Example + +```csharp +UpdateSubscriptionSnapDay value = UpdateSubscriptionSnapDay.FromString("String0"); +``` + +## int + +### Initialization Code + +#### Example + +```csharp +UpdateSubscriptionSnapDay value = UpdateSubscriptionSnapDay.FromNumber(0); +``` + diff --git a/doc/models/containers/usage-quantity.md b/doc/models/containers/usage-quantity.md index 1316634e..c8580e44 100644 --- a/doc/models/containers/usage-quantity.md +++ b/doc/models/containers/usage-quantity.md @@ -12,3 +12,23 @@ | `int` | UsageQuantity.FromNumber(int number) | | `string` | UsageQuantity.FromString(string mString) | +## int + +### Initialization Code + +#### Example + +```csharp +UsageQuantity value = UsageQuantity.FromNumber(0); +``` + +## string + +### Initialization Code + +#### Example + +```csharp +UsageQuantity value = UsageQuantity.FromString("String0"); +``` + diff --git a/doc/models/create-allocation.md b/doc/models/create-allocation.md index 4b12f4b6..f1d4b957 100644 --- a/doc/models/create-allocation.md +++ b/doc/models/create-allocation.md @@ -22,7 +22,7 @@ | `AccrueCharge` | `bool?` | Optional | "If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately.

`true` - Attempt to charge the customer at the next renewal.

`false` - Attempt to charge the customer right away. If it fails, the charge will be accrued until the next renewal.

Defaults to the site setting if unspecified in the request. | | `InitiateDunning` | `bool?` | Optional | If set to true, if the immediate component payment fails, initiate dunning for the subscription.
Otherwise, leave the charges on the subscription to pay for at renewal. Defaults to false. | | `PricePointId` | [`CreateAllocationPricePointId`](../../doc/models/containers/create-allocation-price-point-id.md) | Optional | This is a container for one-of cases. | -| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. | +| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. | | `CustomPrice` | [`ComponentCustomPrice`](../../doc/models/component-custom-price.md) | Optional | Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. | ## Example (as JSON) diff --git a/doc/models/create-invoice.md b/doc/models/create-invoice.md index e33d1afb..ae1947f4 100644 --- a/doc/models/create-invoice.md +++ b/doc/models/create-invoice.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `LineItems` | [`List`](../../doc/models/create-invoice-item.md) | Optional | - | -| `IssueDate` | `DateTime?` | Optional | - | +| `IssueDate` | `DateTime?` | Optional | Date on which the invoice will be issued (format YYYY-MM-DD). This date is interpreted and validated in your site's time zone. It must be today or a date in the past — future dates are not accepted. If omitted, defaults to today in your site's time zone. | | `NetTerms` | `int?` | Optional | By default, invoices will be created with a due date matching the date of invoice creation. If a different due date is desired, the net_terms parameter can be sent indicating the number of days in advance the due date should be. | | `PaymentInstructions` | `string` | Optional | - | | `Memo` | `string` | Optional | A custom memo can be sent to override the site's default. | diff --git a/doc/models/create-on-off-component.md b/doc/models/create-on-off-component.md index f57d38ed..82fd9d99 100644 --- a/doc/models/create-on-off-component.md +++ b/doc/models/create-on-off-component.md @@ -1,5 +1,5 @@ -# Create on Off Component +# Create On Off Component ## Structure diff --git a/doc/models/create-or-update-endpoint-request.md b/doc/models/create-or-update-endpoint-request.md index 22802c88..98747d16 100644 --- a/doc/models/create-or-update-endpoint-request.md +++ b/doc/models/create-or-update-endpoint-request.md @@ -20,7 +20,7 @@ Used to Create or Update Endpoint "endpoint": { "url": "url2", "webhook_subscriptions": [ - "dunning_step_reached" + "subscription_prepayment_account_balance_changed" ] } } diff --git a/doc/models/create-or-update-endpoint.md b/doc/models/create-or-update-endpoint.md index 3a867991..33f78397 100644 --- a/doc/models/create-or-update-endpoint.md +++ b/doc/models/create-or-update-endpoint.md @@ -20,7 +20,7 @@ Used to Create or Update Endpoint { "url": "url8", "webhook_subscriptions": [ - "payment_success" + "refund_success" ] } ``` diff --git a/doc/models/create-payment-profile.md b/doc/models/create-payment-profile.md index 0417174e..c3e16e2e 100644 --- a/doc/models/create-payment-profile.md +++ b/doc/models/create-payment-profile.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `ChargifyToken` | `string` | Optional | Token received after sending billing information using chargify.js. | +| `ChargifyToken` | `string` | Optional | Token received after sending billing information using Maxio.js (formerly Chargify.js). | | `Id` | `int?` | Optional | - | | `PaymentType` | [`PaymentType?`](../../doc/models/payment-type.md) | Optional | - | | `FirstName` | `string` | Optional | First name on card or bank account. If omitted, the first_name from customer attributes will be used. | @@ -29,8 +29,8 @@ | `VaultToken` | `string` | Optional | The “token” provided by your vault storage for an already stored payment profile | | `CustomerVaultToken` | `string` | Optional | (only for Authorize.Net CIM storage or Square) The customerProfileId for the owner of the customerPaymentProfileId provided as the vault_token | | `CustomerId` | `int?` | Optional | (Required when creating a new payment profile) The Chargify customer id. | -| `PaypalEmail` | `string` | Optional | used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Chargify.js instead. | -| `PaymentMethodNonce` | `string` | Optional | used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Chargify.js instead. | +| `PaypalEmail` | `string` | Optional | used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Maxio.js (formerly Chargify.js) instead. | +| `PaymentMethodNonce` | `string` | Optional | used by merchants that implemented BraintreeBlue javaScript libraries on their own. We recommend using Maxio.js (formerly Chargify.js) instead. | | `GatewayHandle` | `string` | Optional | This attribute is only available if MultiGateway feature is enabled for your Site. This feature is in the Private Beta currently. gateway_handle is used to directly select a gateway where a payment profile will be stored in. Every connected gateway must have a unique gateway handle specified. Read [Multigateway description](https://chargify.zendesk.com/hc/en-us/articles/4407761759643#connecting-with-multiple-gateways) to learn more about new concepts that MultiGateway introduces and the default behavior when this attribute is not passed. | | `Cvv` | `string` | Optional | The 3- or 4-digit Card Verification Value. This value is merely passed through to the payment gateway. | | `BankName` | `string` | Optional | (Required when creating with ACH or GoCardless, optional with Stripe Direct Debit). The name of the bank where the customerʼs account resides | diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md index 5619886a..9acc90ee 100644 --- a/doc/models/create-subscription-request.md +++ b/doc/models/create-subscription-request.md @@ -23,7 +23,6 @@ }, "dunning_communication_delay_enabled": false, "dunning_communication_delay_time_zone": "\"Eastern Time (US & Canada)\"", - "skip_billing_manifest_taxes": false, "product_handle": "product_handle6", "product_id": 206, "product_price_point_handle": "product_price_point_handle2", diff --git a/doc/models/create-subscription.md b/doc/models/create-subscription.md index 4bb169f7..5f3f7afc 100644 --- a/doc/models/create-subscription.md +++ b/doc/models/create-subscription.md @@ -58,7 +58,7 @@ | `AchAgreement` | [`ACHAgreement`](../../doc/models/ach-agreement.md) | Optional | (Optional) If passed, the proof of the authorized ACH agreement terms will be persisted. | | `DunningCommunicationDelayEnabled` | `bool?` | Optional | Enable Communication Delay feature, making sure no communication (email or SMS) is sent to the Customer between 9PM and 8AM in time zone set by the `dunning_communication_delay_time_zone` attribute.

**Default**: `false` | | `DunningCommunicationDelayTimeZone` | `string` | Optional | Time zone for the Dunning Communication Delay feature. | -| `SkipBillingManifestTaxes` | `bool?` | Optional | Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests.

**Default**: `false` | +| `SkipBillingManifestTaxes` | `bool?` | Optional | Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests. Defaults to `false` when not provided. | ## Example (as JSON) @@ -71,7 +71,6 @@ }, "dunning_communication_delay_enabled": false, "dunning_communication_delay_time_zone": "\"Eastern Time (US & Canada)\"", - "skip_billing_manifest_taxes": false, "product_handle": "product_handle6", "product_id": 212, "product_price_point_handle": "product_price_point_handle0", diff --git a/doc/models/create-usage.md b/doc/models/create-usage.md index 1e5adbf7..1a25c822 100644 --- a/doc/models/create-usage.md +++ b/doc/models/create-usage.md @@ -12,7 +12,7 @@ | `Quantity` | `double?` | Optional | integer by default or decimal number if fractional quantities are enabled for the component | | `PricePointId` | `string` | Optional | - | | `Memo` | `string` | Optional | - | -| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | This attribute is particularly useful when you need to align billing events for different components on distinct schedules within a subscription. This only works for site with Multifrequency enabled. | +| `BillingSchedule` | [`BillingSchedule`](../../doc/models/billing-schedule.md) | Optional | Billing schedule settings for component allocations or usages on multi-frequency subscriptions. Use this to start a component's billing period on a custom date instead of aligning with the product charge schedule. | | `CustomPrice` | [`ComponentCustomPrice`](../../doc/models/component-custom-price.md) | Optional | Create or update custom pricing unique to the subscription. Used in place of `price_point_id`. | ## Example (as JSON) diff --git a/doc/models/credit-card-payment-profile.md b/doc/models/credit-card-payment-profile.md index 081aa57d..7cd89cb8 100644 --- a/doc/models/credit-card-payment-profile.md +++ b/doc/models/credit-card-payment-profile.md @@ -28,7 +28,7 @@ | `BillingAddress2` | `string` | Optional | The current billing street address, second line, for the card. | | `PaymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.credit_card` | | `Disabled` | `bool?` | Optional | - | -| `ChargifyToken` | `string` | Optional | Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | +| `ChargifyToken` | `string` | Optional | Token received after sending billing information using Maxio.js (formerly Chargify.js). This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | | `SiteGatewaySettingId` | `int?` | Optional | - | | `GatewayHandle` | `string` | Optional | An identifier of connected gateway. | | `CreatedAt` | `DateTimeOffset?` | Optional | A timestamp indicating when this payment profile was created | diff --git a/doc/models/credit-note-line-item.md b/doc/models/credit-note-line-item.md index 2fff622a..b056f44e 100644 --- a/doc/models/credit-note-line-item.md +++ b/doc/models/credit-note-line-item.md @@ -17,6 +17,7 @@ | `SubtotalAmount` | `string` | Optional | The line subtotal, generally calculated as `quantity * unit_price`. This is the canonical amount of record for the line - when rounding differences are in play, `subtotal_amount` takes precedence over the value derived from `quantity * unit_price` (which may not have the proper precision to exactly equal this amount). | | `DiscountAmount` | `string` | Optional | The approximate discount of just this line.

The value is approximated in cases where rounding errors make it difficult to apportion exactly a total discount among many lines. Several lines may have been summed prior to applying the discount to arrive at `discount_amount` for the invoice - backing that out to the discount on a single line may introduce rounding or precision errors. | | `TaxAmount` | `string` | Optional | The approximate tax of just this line.

The value is approximated in cases where rounding errors make it difficult to apportion exactly a total tax among many lines. Several lines may have been summed prior to applying the tax rate to arrive at `tax_amount` for the invoice - backing that out to the tax on a single line may introduce rounding or precision errors. | +| `TaxIncluded` | `bool?` | Optional | Whether the unit price for this line item is tax-inclusive.

When `true`, `unit_price` already includes tax and `tax_amount` represents the portion of the price attributable to tax. When `false`, any applicable tax is added on top of the price.

The value is inherited from the source price point's `tax_included` setting. Custom or ad-hoc line items (which have no associated price point) always return `false`. | | `TotalAmount` | `string` | Optional | The non-canonical total amount for the line.

`subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter. Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`. | | `TieredUnitPrice` | `bool?` | Optional | When `true`, indicates that the actual pricing scheme for the line was tiered, so the `unit_price` shown is the blended average for all units. | | `PeriodRangeStart` | `DateTime?` | Optional | Start date for the period credited by this line. The format is `"YYYY-MM-DD"`. | @@ -27,6 +28,7 @@ | `PricePointId` | `int?` | Optional | The price point ID of the component being credited. Will be `nil` for non-component credits. | | `BillingScheduleItemId` | `int?` | Optional | - | | `CustomItem` | `bool?` | Optional | - | +| `PrepaidAllocationExpiresAt` | `DateTime?` | Optional | The date a prepaid allocation is set to expire. Only present on line items representing prepaid component allocations. The format is `"YYYY-MM-DD"`. | ## Example (as JSON) diff --git a/doc/models/customer.md b/doc/models/customer.md index 45396c6a..887584b3 100644 --- a/doc/models/customer.md +++ b/doc/models/customer.md @@ -39,6 +39,7 @@ | `SalesforceId` | `string` | Optional | The Salesforce ID for the customer | | `TaxExemptReason` | `string` | Optional | The Tax Exemption Reason Code for the customer | | `DefaultAutoRenewalProfileId` | `int?` | Optional | The default auto-renewal profile ID for the customer | +| `Maxioid` | `string` | Optional | The Maxio-generated unique identifier for the customer. | ## Example (as JSON) diff --git a/doc/models/event-key.md b/doc/models/event-key.md index d38126df..351618c0 100644 --- a/doc/models/event-key.md +++ b/doc/models/event-key.md @@ -42,6 +42,7 @@ | `TrialEndNotice` | | `DunningStepReached` | | `InvoiceIssued` | +| `InvoicePending` | | `PrepaidSubscriptionBalanceChanged` | | `SubscriptionGroupSignupSuccess` | | `SubscriptionGroupSignupFailure` | @@ -85,6 +86,8 @@ | `ChargebackWon` | | `PaymentCollectionMethodChanged` | | `ComponentBillingDateChanged` | +| `ChjsTokenizationFailure` | +| `ChjsTokenizationSuccess` | | `SubscriptionTermRenewalScheduled` | | `SubscriptionTermRenewalPending` | | `SubscriptionTermRenewalActivated` | diff --git a/doc/models/event-response.md b/doc/models/event-response.md index 3f16dca0..d617241c 100644 --- a/doc/models/event-response.md +++ b/doc/models/event-response.md @@ -17,7 +17,7 @@ { "event": { "id": 242, - "key": "subscription_state_change", + "key": "maxio_payments_direct_debit_payment_rejected", "message": "message0", "subscription_id": 96, "customer_id": 24, diff --git a/doc/models/event.md b/doc/models/event.md index 1365184b..30048080 100644 --- a/doc/models/event.md +++ b/doc/models/event.md @@ -22,7 +22,7 @@ ```json { "id": 40, - "key": "invoice_issued", + "key": "subscription_group_signup_success", "message": "message8", "subscription_id": 150, "customer_id": 78, diff --git a/doc/models/invoice-line-item.md b/doc/models/invoice-line-item.md index 9cf4059a..eaa11ab2 100644 --- a/doc/models/invoice-line-item.md +++ b/doc/models/invoice-line-item.md @@ -17,6 +17,7 @@ | `SubtotalAmount` | `string` | Optional | The line subtotal, generally calculated as `quantity * unit_price`. This is the canonical amount of record for the line - when rounding differences are in play, `subtotal_amount` takes precedence over the value derived from `quantity * unit_price` (which may not have the proper precision to exactly equal this amount). | | `DiscountAmount` | `string` | Optional | The approximate discount applied to just this line.

The value is approximated in cases where rounding errors make it difficult to apportion exactly a total discount among many lines. Several lines may have been summed prior to applying the discount to arrive at `discount_amount` for the invoice - backing that out to the discount on a single line may introduce rounding or precision errors. | | `TaxAmount` | `string` | Optional | The approximate tax applied to just this line.

The value is approximated in cases where rounding errors make it difficult to apportion exactly a total tax among many lines. Several lines may have been summed prior to applying the tax rate to arrive at `tax_amount` for the invoice - backing that out to the tax on a single line may introduce rounding or precision errors. | +| `TaxIncluded` | `bool?` | Optional | Whether the unit price for this line item is tax-inclusive.

When `true`, `unit_price` already includes tax and `tax_amount` represents the portion of the price attributable to tax. When `false`, any applicable tax is added on top of the price.

The value is inherited from the source price point's `tax_included` setting. Custom or ad-hoc line items (which have no associated price point) always return `false`. | | `TotalAmount` | `string` | Optional | The non-canonical total amount for the line.

`subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter. Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`. | | `TieredUnitPrice` | `bool?` | Optional | When `true`, indicates that the actual pricing scheme for the line was tiered, so the `unit_price` shown is the blended average for all units. | | `PeriodRangeStart` | `DateTime?` | Optional | Start date for the period covered by this line. The format is `"YYYY-MM-DD"`.

* For periodic charges paid in advance, this date will match the billing date, and the end date will be in the future.
* For periodic charges paid in arrears (e.g. metered charges), this date will be the date of the previous billing, and the end date will be the current billing date.
* For non-periodic charges, this date and the end date will match. | @@ -32,6 +33,7 @@ | `ProductPricePointId` | `int?` | Optional | The price point ID of the line item's product | | `CustomItem` | `bool?` | Optional | - | | `Kind` | `string` | Optional | - | +| `PrepaidAllocationExpiresAt` | `DateTime?` | Optional | The date a prepaid allocation is set to expire. Only present on line items representing prepaid component allocations. The format is `"YYYY-MM-DD"`. | ## Example (as JSON) diff --git a/doc/models/list-mrr-per-subscription-input.md b/doc/models/list-mrr-per-subscription-input.md index fb158720..6d4a77a8 100644 --- a/doc/models/list-mrr-per-subscription-input.md +++ b/doc/models/list-mrr-per-subscription-input.md @@ -1,5 +1,5 @@ -# List Mrr Per Subscription Input +# List Mrr per Subscription Input Input structure for the method ListMrrPerSubscription diff --git a/doc/models/payment-profile-attributes.md b/doc/models/payment-profile-attributes.md index e4560986..8a228a50 100644 --- a/doc/models/payment-profile-attributes.md +++ b/doc/models/payment-profile-attributes.md @@ -11,7 +11,7 @@ alias to credit_card_attributes | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `ChargifyToken` | `string` | Optional | (Optional) Token received after sending billing information using chargify.js. This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | +| `ChargifyToken` | `string` | Optional | (Optional) Token received after sending billing information using Maxio.js (formerly Chargify.js). This token must be passed as a sole attribute of `payment_profile_attributes` (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | | `Id` | `int?` | Optional | - | | `PaymentType` | [`PaymentType?`](../../doc/models/payment-type.md) | Optional | - | | `FirstName` | `string` | Optional | (Optional) First name on card or bank account. If omitted, the first_name from customer attributes will be used. | diff --git a/doc/models/payment-profile-params.md b/doc/models/payment-profile-params.md new file mode 100644 index 00000000..d7af6c32 --- /dev/null +++ b/doc/models/payment-profile-params.md @@ -0,0 +1,27 @@ + +# Payment Profile Params + +PCI-safe cardholder fields only. Full card numbers, CVV, and billing address are never included. + +## Structure + +`PaymentProfileParams` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `FirstName` | `string` | Optional | - | +| `LastName` | `string` | Optional | - | +| `CardType` | `string` | Optional | - | + +## Example (as JSON) + +```json +{ + "first_name": "first_name2", + "last_name": "last_name0", + "card_type": "card_type8" +} +``` + diff --git a/doc/models/site.md b/doc/models/site.md index 4767e804..3a3f5c63 100644 --- a/doc/models/site.md +++ b/doc/models/site.md @@ -25,6 +25,9 @@ | `OrganizationAddress` | [`OrganizationAddress`](../../doc/models/organization-address.md) | Optional | - | | `TaxConfiguration` | [`TaxConfiguration`](../../doc/models/tax-configuration.md) | Optional | - | | `NetTerms` | [`NetTerms`](../../doc/models/net-terms.md) | Optional | - | +| `MultiFrequencyEnabled` | `bool?` | Optional | Whether the site has the multi-frequency billing feature enabled. Only present when relationship invoicing is active. | +| `AutoRenewalsEnabled` | `bool?` | Optional | Whether the auto-renewals feature is enabled for this site. | +| `PortalEnabled` | `bool?` | Optional | Whether the Billing Portal is enabled for this site. | | `Test` | `bool?` | Optional | - | ## Example (as JSON) diff --git a/doc/models/tokenized-payment-profile.md b/doc/models/tokenized-payment-profile.md new file mode 100644 index 00000000..b5a0a79f --- /dev/null +++ b/doc/models/tokenized-payment-profile.md @@ -0,0 +1,27 @@ + +# Tokenized Payment Profile + +## Structure + +`TokenizedPaymentProfile` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `Id` | `int` | Required | - | +| `VaultToken` | `string` | Optional | - | +| `GatewayHandle` | `string` | Optional | - | +| `CustomerVaultToken` | `string` | Optional | - | + +## Example (as JSON) + +```json +{ + "id": 72, + "vault_token": "vault_token2", + "gateway_handle": "gateway_handle8", + "customer_vault_token": "customer_vault_token8" +} +``` + diff --git a/doc/models/webhook-subscription.md b/doc/models/webhook-subscription.md index 3847d799..6a308306 100644 --- a/doc/models/webhook-subscription.md +++ b/doc/models/webhook-subscription.md @@ -11,12 +11,15 @@ | --- | | `BillingDateChange` | | `ComponentAllocationChange` | +| `ChjsTokenizationFailure` | +| `ChjsTokenizationSuccess` | | `CustomerCreate` | | `CustomerUpdate` | | `DunningStepReached` | | `ExpiringCard` | | `ExpirationDateChange` | | `InvoiceIssued` | +| `InvoicePending` | | `MeteredUsage` | | `PaymentFailure` | | `PaymentSuccess` |