@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

Returns a list of your payment links.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param active [Bool?] Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentLinksResourcePaymentLinkList]

<p>Returns a list of your payment links.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param active [Bool?] Only return payment links that are active or inactive (e.g., pass false to list all inactive payment links). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

Retrieve a payment link.

@required @param payment_link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentLink]

<p>Retrieve a payment link.</p> @required @param payment_link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

@required @param payment_link [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentLinksResourceListLineItems]

<p>When retrieving a payment link, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p> @required @param payment_link [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>When retrieving a payment link, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p> @required @param payment_link [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentLinksResourceListLineItems, Integer, Hash)] Stripe::PaymentLinksResourceListLineItems, response status code and response headers

<p>Retrieve a payment link.</p> @required @param payment_link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentLink, Integer, Hash)] Stripe::PaymentLink, response status code and response headers

<p>Returns a list of your payment links.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param active [Bool?] Only return payment links that are active or inactive (e.g., pass false to list all inactive payment links). @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentLinksResourcePaymentLinkList, Integer, Hash)] Stripe::PaymentLinksResourcePaymentLinkList, response status code and response headers

Creates a payment link.

@required @param line_items [Array(Stripe::LineItemsCreateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param application_fee_amount [Int32?] The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. @optional @param application_fee_percent [Float64?] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to `auto`. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [String?] The custom message to be displayed to a customer when a payment link is no longer active. @optional @param invoice_creation [Stripe::InvoiceCreationCreateParams?] @optional @param metadata [Hash(String, String)?] @optional @param on_behalf_of [String?] The account on behalf of which to charge. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). @optional @param payment_method_types [Array(String)?] The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param restrictions [Stripe::RestrictionsParams?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. @optional @param submit_type [String?] Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param transfer_data [Stripe::TransferDataParams?] @return [Stripe::PaymentLink]

<p>Creates a payment link.</p> @required @param line_items [Array(Stripe::LineItemsCreateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param application_fee_amount [Int32?] The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. @optional @param application_fee_percent [Float64?] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to auto. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency and supported by each line item's price. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether checkout sessions created by this payment link create a Customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [String?] The custom message to be displayed to a customer when a payment link is no longer active. @optional @param invoice_creation [Stripe::InvoiceCreationCreateParams?] @optional @param metadata [Hash(String, String)?] @optional @param on_behalf_of [String?] The account on behalf of which to charge. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_types [Array(String)?] The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your payment method settings (20+ payment methods supported). @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param restrictions [Stripe::RestrictionsParams?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to checkout sessions created by this payment link. @optional @param submit_type [String?] Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the url property (example: donate.stripe.com). @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param transfer_data [Stripe::TransferDataParams?] @return nil

Updates a payment link.

@required @param payment_link [String?] @optional @param active [Bool?] Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to `auto`. @optional @param custom_fields [Stripe::PostPaymentLinksPaymentLinkRequestCustomFields?] @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [Stripe::PostPaymentLinksPaymentLinkRequestInactiveMessage?] @optional @param invoice_creation [Stripe::InvoiceCreationUpdateParams?] @optional @param line_items [Array(Stripe::LineItemsUpdateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent_data [Stripe::PaymentIntentDataUpdateParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). @optional @param payment_method_types [Stripe::PostPaymentLinksPaymentLinkRequestPaymentMethodTypes?] @optional @param restrictions [Stripe::PostPaymentLinksPaymentLinkRequestRestrictions?] @optional @param shipping_address_collection [Stripe::PostPaymentLinksPaymentLinkRequestShippingAddressCollection?] @optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @return [Stripe::PaymentLink]

<p>Updates a payment link.</p> @required @param payment_link [String?] @optional @param active [Bool?] Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to auto. @optional @param custom_fields [Stripe::PostPaymentLinksPaymentLinkRequestCustomFields?] @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether checkout sessions created by this payment link create a Customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [Stripe::PostPaymentLinksPaymentLinkRequestInactiveMessage?] @optional @param invoice_creation [Stripe::InvoiceCreationUpdateParams?] @optional @param line_items [Array(Stripe::LineItemsUpdateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent_data [Stripe::PaymentIntentDataUpdateParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_types [Stripe::PostPaymentLinksPaymentLinkRequestPaymentMethodTypes?] @optional @param restrictions [Stripe::PostPaymentLinksPaymentLinkRequestRestrictions?] @optional @param shipping_address_collection [Stripe::PostPaymentLinksPaymentLinkRequestShippingAddressCollection?] @optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @return nil

<p>Updates a payment link.</p> @required @param payment_link [String?] @optional @param active [Bool?] Whether the payment link's url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to auto. @optional @param custom_fields [Stripe::PostPaymentLinksPaymentLinkRequestCustomFields?] @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether checkout sessions created by this payment link create a Customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [Stripe::PostPaymentLinksPaymentLinkRequestInactiveMessage?] @optional @param invoice_creation [Stripe::InvoiceCreationUpdateParams?] @optional @param line_items [Array(Stripe::LineItemsUpdateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param metadata [Hash(String, String)?] @optional @param payment_intent_data [Stripe::PaymentIntentDataUpdateParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_types [Stripe::PostPaymentLinksPaymentLinkRequestPaymentMethodTypes?] @optional @param restrictions [Stripe::PostPaymentLinksPaymentLinkRequestRestrictions?] @optional @param shipping_address_collection [Stripe::PostPaymentLinksPaymentLinkRequestShippingAddressCollection?] @optional @param subscription_data [Stripe::SubscriptionDataUpdateParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @return [Tuple(Stripe::PaymentLink, Integer, Hash)] Stripe::PaymentLink, response status code and response headers

<p>Creates a payment link.</p> @required @param line_items [Array(Stripe::LineItemsCreateParams)?] The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported. @optional @param after_completion [Stripe::AfterCompletionParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param application_fee_amount [Int32?] The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Can only be applied when there are no line items with recurring prices. @optional @param application_fee_percent [Float64?] A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Configuration for collecting the customer's billing address. Defaults to auto. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency and supported by each line item's price. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer_creation [String?] Configures whether checkout sessions created by this payment link create a Customer. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param inactive_message [String?] The custom message to be displayed to a customer when a payment link is no longer active. @optional @param invoice_creation [Stripe::InvoiceCreationCreateParams?] @optional @param metadata [Hash(String, String)?] @optional @param on_behalf_of [String?] The account on behalf of which to charge. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_types [Array(String)?] The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your payment method settings (20+ payment methods supported). @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param restrictions [Stripe::RestrictionsParams?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to checkout sessions created by this payment link. @optional @param submit_type [String?] Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the url property (example: donate.stripe.com). @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param transfer_data [Stripe::TransferDataParams?] @return [Tuple(Stripe::PaymentLink, Integer, Hash)] Stripe::PaymentLink, response status code and response headers