Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds bulk parameter to SubscriptionCreate and SubscriptionPurchase #915

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/recurly/requests/subscription_create.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ class SubscriptionCreate < Request
# @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
define_attribute :billing_info_id, String

# @!attribute bulk
# @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
define_attribute :bulk, :Boolean

# @!attribute collection_method
# @return [String] Collection method
define_attribute :collection_method, String
Expand Down
4 changes: 4 additions & 0 deletions lib/recurly/requests/subscription_purchase.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ class SubscriptionPurchase < Request
# @return [Boolean] Whether the subscription renews at the end of its term.
define_attribute :auto_renew, :Boolean

# @!attribute bulk
# @return [Boolean] Optional field to be used only when needing to bypass the 60 second limit on creating subscriptions. Should only be used when creating subscriptions in bulk from the API.
define_attribute :bulk, :Boolean

# @!attribute custom_fields
# @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
define_attribute :custom_fields, Array, { :item_type => :CustomField }
Expand Down
21 changes: 17 additions & 4 deletions openapi/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9915,10 +9915,11 @@ paths:
summary: Refund an invoice
description: |
There are two ways to do a refund:
* refund a specific amount which is divided across all the line items.
* refund quantities of line items.
If you want to refund the entire refundable amount on the invoice, the
simplest way is to do `type=amount` without specifiying an `amount`.
* Apply a specific dollar/cent amount or percentage amount to an entire invoice, which will refund the resulting amount across all line items on the invoice.
* If you want to refund the entire refundable amount on the invoice, the simplest way is to do `type=amount` without specifiying an `amount`.
* Note: You must have the Credit Memos feature flag enabled on your site to utilize percentage amount refunds on invoices.
* Apply a refund to one or more individual line items on an invoice. A line item can be refunded by a quantity amount, a specific dollar/cent amount, or a percentage amount and will only apply to the specific line item you are aiming to refund.
* Note: You must have the Credit Memos feature flag enabled on your site to utilize specific dollar/cent amount and percentage amount refunds on line items.
parameters:
- "$ref": "#/components/parameters/invoice_id"
requestBody:
Expand Down Expand Up @@ -23562,6 +23563,12 @@ components:
title: Gift card Redemption Code
description: A gift card redemption code to be redeemed on the purchase
invoice.
bulk:
type: boolean
description: Optional field to be used only when needing to bypass the 60
second limit on creating subscriptions. Should only be used when creating
subscriptions in bulk from the API.
default: false
required:
- plan_code
- currency
Expand Down Expand Up @@ -23664,6 +23671,12 @@ components:
description: The new set of ramp intervals for the subscription.
items:
"$ref": "#/components/schemas/SubscriptionRampInterval"
bulk:
type: boolean
description: Optional field to be used only when needing to bypass the 60
second limit on creating subscriptions. Should only be used when creating
subscriptions in bulk from the API.
default: false
required:
- plan_code
SubscriptionUpdate:
Expand Down
Loading