v0.7.1

📝 Changelog: API Documentation Updates

We've made several updates to the API documentation to improve clarity, consistency, and accuracy. This release includes enhancements to the descriptions for various endpoints, corrections to example data, and updates to external links.

---

🌐 Webhooks API Improvements

• Simplified descriptions: We've streamlined the descriptions for several webhook endpoints, including List Webhooks, Enable Webhooks, Replay Webhooks, Create Endpoint, Update Endpoint, and List Endpoints, to make them more concise and easier to understand.
• Updated documentation links: All internal and external links within the webhook documentation have been updated to point to the correct, current resources.

---

💰 Billing and Subscription Updates

• Enhanced Customer API: The Read Customer endpoint now includes a complete example response, providing a clearer picture of the data you'll receive from the API.
• Component Price Point examples: We've added new examples for Volume and Tiered price points to the Create Component Price Point endpoint, providing clearer guidance for different pricing schemes. The Stairstep Price Point example was also corrected to include a valid ending_quantity.
• Flexible Subscription Usage: The subscription_id path parameter for the Create Usage endpoint has been updated to subscription_id_or_reference. This allows you to use either the subscription's ID or its reference string, making the endpoint more flexible.
• Updated documentation links: The links in the documentation for GoCardless, Stripe SEPA/BECS Direct Debit, and Chargify.js have been corrected to ensure they point to the latest and most relevant documentation.

---

🧰 General Enhancements

• Concise descriptions: We've shortened descriptions for the Read Customer and Read Component endpoints to be more direct.
• Improved link consistency: All external links, especially those referencing Chargify.js and various examples, have been reviewed and updated to the correct, canonical URLs.

v0.7.0

• List Service Credits: Added a new endpoint (GET /service_credits.json) to list service credits.
• Invoice Consolidation: Introduced a consolidation_level parameter to the GET /invoices.json endpoint to control how invoices are grouped.
• Filter by Coupon Code: Added a coupon_code parameter to filter subscriptions.
• New Component Field: The product_family_handle field has been added to the Read/List Components endpoints.
• New Payment Profile Fields: Added created_at and updated_at fields to the payment profile schema.
• New Invoice Field: The received_on date has been added to the Read Invoice endpoint response.
• Deferred Signup: Added support for defer_signup in payment examples.

v0.6.0

What's Changed

• Added scheduleSubscriptionCancellationEnabled property to the Site model
• Added string representations for models

Full Changelog: v0.5.0...v0.6.0

v0.5.0

• AdvancedBillingClient was slightly reworked:

  • Domain parameter has been removed.
  • Subdomain parameter changed name to site
  • Environment has changed. Now it's either default US, or EU for Advanced Billing eu hosting. The default is US. SDK is now supporting EU hosted accounts.

• Coupon fixes:

  • renamed CreateOrUpdateCoupon to CouponRequest
  • renamed CreateOrUpdatePercentageCouponPercentage to CouponPayloadPercentage
  • changed CreateOrUpdateCouponCoupon to CouponPayload
  • There're no longer 2 distinct models for Flat amount and Percentage coupon. They're merged into CouponPayload. Using it, specify either AmountInCents or Percentage property
  • Code, Name, Description, AmountInCents and Percentage are not required properties in CouponPayload model. It means they're not send as nulls if unset. It enables patching coupon with UpdateCoupon without specifying these properties values. Previous version enforced setting them.
  • CouponPayload EndDate changes type from ZonedDateTime to LocalDate. Response Coupon EndDate is still ZonedDateTime (its calculated as end of the day)
  • UpdateCoupon now throws ErrorListResponseException
  • added CurrencyPrices for Coupon response. Note you need to specify suitable query parameters to access it
  • added CurrencyPrices query parameter for ReadCoupon and FindCoupon
  • added some missing descriptions
  • changed Coupon AmountInCents to Long
  • changed CouponCurrency Price to nullable Double and id to nullable Integer
  • CreateOrUpdateCouponCurrencyPrices now throws ErrorStringMapResponseException

• Subscription Fixes:

  • added SubscriptionResponse for PurgeSubscription operation
  • PurgeSubscription now throws SubscriptionResponseErrorException
  • UpdatePrepaidSubscriptionConfiguration now throws ApiException when the status code is 422

• Components fixes:

  • removed PrepaidComponentPricePoint. Use CreatePrepaidComponentPricePoint when creating price points for PrepaidComponent together with component instead
  • added prepaid-specific properties to ComponentPricePoint (response model)
  • removed UpgradeCharge and DowngradeCredit from EbbComponent, OnOffComponent and MeteredComponent request models (not applicable for this type of component)
  • removed deprecated PriceInCents from component request models
  • removed prices from OnOffComponent request model (unitPrice should be used)
  • Fixed ComponentPricePoint ExpirationIntervalUnit type
  • corrected some descriptions
  • Define exceptions for create component price points operations

• Currency Prices fixes:

  • add CurrencyPrices query parameter to ReadComponentPricePoint
  • UpdateCurrencyPrice Price is now Double instead of Int
  • Add PriceId and PricePointId to CurrencyPrice
  • Return verbose exception message for currency prices operations

• Events fixes:

  • Added EventKey enum and filled it with missing event types
  • merged SubscriptionGroupSignupFailure and SubscriptionGroupSignupFailure and SubscriptionGroupSignupSuccess into SubscriptionGroupSignupEventData.
  • documented Key to EventSpecificData mappings.
  • removed EventType used in Events endpoints for filter. EventKey should be used instead.

• Misc:

  • Added missing properties and types for Invoice
  • fixed RecordEvent and BulkRecordEvents. Now they work with default environment, with subdomain specified during client initialization. They no longer need subdomain provided to the method execution
  • Fixed types for models required for update subscription group and add subscription to group operations
  • Make InitiateDelayedCancellation and CancelDunning throw ErrorListResponseException on 422 error
  • added processing Invoice Status
  • Fix errors for Subscription Notes
  • Add error model for ListOffers
  • Use date/dateTime instead of string for filtering when listing products and product families
  • Now it's possible to list archived product price points using Archived property with ListProductPricePoints

Full Changelog: v0.4.2...v0.5.0

v0.4.2

What's Changed

• Added tax_exempt_reason and default_auto_renewal_profile_id to Customer
• Added received_on to InvoicePayment and CreateInvoicePayment
• Added product_price_point_id and product_price_point_handle to UpdateSubscription
• Improved some properties descriptions

Full Changelog: v0.4.1...v0.4.2

v0.4.1

What's Changed

• Add imported to subscription cancellation_method
• Add id filter to List Products API

Full Changelog: v0.4.0...v0.4.1

v0.4.0

What's Changed

• DE-934 Setup tests for a new site by @michalpierog in #30
• [DE-932] Release v0.4.0 by @maciej-nedza in #31
• DE-921 DE-922 Fix problem with interval units - interval units now can be nullable in various contexts, ExtendedIntervalUnit was renamed to ExpirationIntervalUnit, now ExpirationIntervalUnit is used in SubscriptionCustomPrice, CreatePrepaidComponentPricePoint, CreateProductPricePoint, CreateOrUpdateProduct, PrepaidComponent, ProductPricePoint and Product for expirationIntervalUnit property. This enum has additional value of never (this has not changed)
• DE-921 DE-924 Reworked vaults - CurrentVault enum was renamed to AllVaults and filled with previously missing values. BankAccountVault was filled with missing values. ApplePayVault was added with the vault supporting this payment method. CreditCardVault was added with vaults supporting this payment method. PayPalVault was added with vaults supporting this payment method. Models for respective payment profiles types now use respective enums.
• DE-910 Distinguish response payment profiles based on the paymentType. PaymentProfileResponsePaymentProfile was renamed to PaymentProfile.ApplePayPaymentProfile, and PayPalPaymentProfile were added as possible PaymentProfile in PaymentProfileResponse. Fixed a bug, when response payment profile couldn't be deserialized due to missing fields.
• Added publicUrlExpires_on to the Invoice
• Added achLateReject to the InvoiceRefund
• Added tax-related properties to InvoiceTaxComponentBreakout and InvoiceTax
• SUB-4037 Add taxIncluded to ComponentCustomPrice. Added request model for Activate Event-Based Component endpoint, SubscriptionComponentActivateEventBasedComponent
  productFamilyId in endpoint paths parameters is now string, to enable searching by both handle and id
• [DE-932] Rename Chargify API by @michalpierog in #32

Full Changelog: v0.3.0...v0.4.0

v0.3.0

What's Changed

• Increase timeout to 120s by default (DE-874)
• Ability to create products using the product family handle - productFamilyId in createProduct method is now String instead of number (SUB-3996 )
• Add API endpoints for finding price points by handle. Move PricePoint methods from ComponentsController to ComponentPricePointsController (IN-3434)

PRs

• [DE-874] Release 0.3.0 by @maciej-nedza in #28

Full Changelog: v0.2.1...v0.3.0

v0.2.1

What's Changed

• Provided default values for domain and subdomain client parameters
• Fixed array form query parameters serialization

PRs:

• [DE-846] Release v0.2.1 by @maciej-nedza in #27

Full Changelog: v0.2.0...v0.2.1

v0.2.0

What's Changed

• Removed redundant container classes
• Changed structure of filters in some list endpoints
• Made some properties nullable
• Added fixes for Subscription Invoice Account endpoints
• ListSubscriptionComponents include query parameter becomes list with additional possible value, HISTORIC_USAGES
• Set usage ids, events ids and invoice event ids as longs
• Add new invoice event data types
• Add handle parameter for create product family request body
• Add in_use query parameter for listing subscription components
• Remove default collection method value
• Reorganize Invoice Event structure:
  • Invoice Event is now union type
  • Invoice Event Data is no longer union type. Each Invoice Event has it's own invoice_data with a concrete type
• Remove some redundant models

PRs:

• [DE-771] Objects for filters in list requests, remove redundant container classes by @maciej-nedza in #20
• [DE771] Fixed crlf issue by @maciej-nedza in #22
• [DE-771] Correct readme version by @maciej-nedza in #21
• [DE-799] Add missing nullable types by @maciej-nedza in #23
• [DE-827] Fix test env by @maciej-nedza in #24
• [DE-801] Fix invoice events structure by @maciej-nedza in #25
• [DE-801] Release v0.2.0 by @maciej-nedza in #26

Full Changelog: v0.1.0...v0.2.0