# Adds Credit Grant APIs and resources ## What’s new Adds new API for managing [billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits.md). You can use these APIs to allocate prepaid or promotional credits to customers which can then be drawn down using subscription invoices for billing meter prices. ## Changes #### REST API | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Endpoints | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `void_grant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### Ruby | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `void_grant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### Python | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `void_grant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### PHP | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `voidGrant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### Java | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `voidGrant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### Node.js | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `list`, `retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `create`, `expire`, `list`, `retrieve`, `update`, `voidGrant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### Go | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `Retrieve` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `List`, `Retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `New`, `Expire`, `List`, `Retrieve`, `Update`, `VoidGrant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | #### .NET | | Change | Resources | | --- | --- | --- | | | Added | [Billing.CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia), [Billing.CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia), [Billing.CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | | Methods | Change | Resources | | --- | --- | --- | | `Get` | Added | [CreditBalanceSummary](/api/billing/credit-balance-summary/object?api-version=2024-10-28.acacia) | | `List`, `Retrieve` | Added | [CreditBalanceTransaction](/api/billing/credit-balance-transaction/object?api-version=2024-10-28.acacia) | | `Create`, `Expire`, `List`, `Get`, `Update`, `VoidGrant` | Added | [CreditGrant](/api/billing/credit-grant?api-version=2024-10-28.acacia) | ## Upgrade #### REST API 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. If you use an SDK, upgrade to the corresponding SDK version for this API version. - If you don’t use an SDK, update your [API requests](https://docs.stripe.com/api/versioning.md) to include `Stripe-Version: 2024-10-28.acacia` 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Ruby 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your Ruby SDK to [v13.1.0](https://github.com/stripe/stripe-ruby/releases/tag/v13.1.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Python 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your Python SDK to [v11.2.0](https://github.com/stripe/stripe-python/releases/tag/v11.2.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### PHP 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your PHP SDK to [v16.2.0](https://github.com/stripe/stripe-php/releases/tag/v16.2.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Java 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your Java SDK to [v28.0.0](https://github.com/stripe/stripe-java/releases/tag/v28.0.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Node.js 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your Node SDK to [v17.3.0](https://github.com/stripe/stripe-node/releases/tag/v17.3.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### Go 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your Go SDK to [v81.0.0](https://github.com/stripe/stripe-go/releases/tag/v81.0.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). #### .NET 1. [View your current API version](https://docs.stripe.com/upgrades.md#view-your-api-version-and-the-latest-available-upgrade-in-workbench) in Workbench. 2. Upgrade your .NET SDK to [v47.0.0](https://github.com/stripe/stripe-dotnet/releases/tag/v47.0.0) 3. Upgrade the API version used for [webhook endpoints](https://docs.stripe.com/webhooks/versioning.md). 4. [Test your integration](https://docs.stripe.com/testing.md) against the new version. 5. If you use Connect, [test your Connect integration](https://docs.stripe.com/connect/testing.md). 6. In Workbench, [perform the upgrade](https://docs.stripe.com/upgrades.md#perform-the-upgrade). You can [roll back the version](https://docs.stripe.com/upgrades.md#roll-back-your-api-version) for 72 hours. Learn more about [Stripe API upgrades](https://docs.stripe.com/upgrades.md). ## Related changes - [Adds support for pre-tax credit amount information to invoices](https://docs.stripe.com/changelog/acacia/2024-10-28/billing-credits-invoice.md) - [Adds support for pre-tax credit amount information to credit notes](https://docs.stripe.com/changelog/acacia/2024-10-28/billing-credits-credit-note.md)