class Stripe::ShippingRatesApi
- Stripe::ShippingRatesApi
- Reference
- Object
Defined in:
stripe/api/shipping_rates_api.crConstant Summary
-
GET_SHIPPING_RATES_MAX_LENGTH_FOR_ENDING_BEFORE =
5000 -
GET_SHIPPING_RATES_MAX_LENGTH_FOR_STARTING_AFTER =
5000 -
GET_SHIPPING_RATES_SHIPPING_RATE_TOKEN_MAX_LENGTH_FOR_SHIPPING_RATE_TOKEN =
5000 -
POST_SHIPPING_RATES_MAX_LENGTH_FOR_DISPLAY_NAME =
100 -
POST_SHIPPING_RATES_SHIPPING_RATE_TOKEN_MAX_LENGTH_FOR_SHIPPING_RATE_TOKEN =
5000 -
POST_SHIPPING_RATES_SHIPPING_RATE_TOKEN_VALID_VALUES_FOR_TAX_BEHAVIOR =
String.static_array("exclusive", "inclusive", "unspecified") -
POST_SHIPPING_RATES_VALID_VALUES_FOR__TYPE =
String.static_array("fixed_amount") -
POST_SHIPPING_RATES_VALID_VALUES_FOR_TAX_BEHAVIOR =
String.static_array("exclusive", "inclusive", "unspecified")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_shipping_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, currency : String | Nil = nil, active : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_shipping_rates(*, display_name : String | Nil = nil, delivery_estimate : Stripe::DeliveryEstimate | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmount | Nil = nil, metadata : Hash(String, String) | Nil = nil, tax_behavior : String | Nil = nil, tax_code : String | Nil = nil, _type : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmountUpdate | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, tax_behavior : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_shipping_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, currency : String | Nil = nil, active : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ShippingResourcesShippingRateList
Returns a list of your shipping rates.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_shipping_rates(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, currency : String | Nil = nil, active : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of your shipping rates.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ShippingRate
Returns the shipping rate object with the given ID.
@required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns the shipping rate object with the given ID.</p> @required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_shipping_rates_shipping_rate_token_with_http_info(*, shipping_rate_token : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ShippingRate, Int32, Hash(String, Array(String) | String))
<p>Returns the shipping rate object with the given ID.</p> @required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_shipping_rates_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, limit : Int64 | Nil = nil, currency : String | Nil = nil, active : Bool | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ShippingResourcesShippingRateList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of your shipping rates.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_shipping_rates(*, display_name : String | Nil = nil, delivery_estimate : Stripe::DeliveryEstimate | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmount | Nil = nil, metadata : Hash(String, String) | Nil = nil, tax_behavior : String | Nil = nil, tax_code : String | Nil = nil, _type : String | Nil = nil) : Stripe::ShippingRate
Creates a new shipping rate object.
@required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer. -
#post_shipping_rates(*, display_name : String | Nil = nil, delivery_estimate : Stripe::DeliveryEstimate | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmount | Nil = nil, metadata : Hash(String, String) | Nil = nil, tax_behavior : String | Nil = nil, tax_code : String | Nil = nil, _type : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new shipping rate object.</p> @required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer.
-
#post_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmountUpdate | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, tax_behavior : String | Nil = nil) : Stripe::ShippingRate
Updates an existing shipping rate object.
@required @param shipping_rate_token [String?] @optional @param active [Bool?] Whether the shipping rate can be used for new purchases. -
#post_shipping_rates_shipping_rate_token(*, shipping_rate_token : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmountUpdate | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, tax_behavior : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing shipping rate object.</p> @required @param shipping_rate_token [String?] @optional @param active [Bool?] Whether the shipping rate can be used for new purchases.
-
#post_shipping_rates_shipping_rate_token_with_http_info(*, shipping_rate_token : String | Nil = nil, active : Bool | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmountUpdate | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, tax_behavior : String | Nil = nil) : Tuple(Stripe::ShippingRate, Int32, Hash(String, Array(String) | String))
<p>Updates an existing shipping rate object.</p> @required @param shipping_rate_token [String?] @optional @param active [Bool?] Whether the shipping rate can be used for new purchases.
-
#post_shipping_rates_with_http_info(*, display_name : String | Nil = nil, delivery_estimate : Stripe::DeliveryEstimate | Nil = nil, expand : Array(String) | Nil = nil, fixed_amount : Stripe::FixedAmount | Nil = nil, metadata : Hash(String, String) | Nil = nil, tax_behavior : String | Nil = nil, tax_code : String | Nil = nil, _type : String | Nil = nil) : Tuple(Stripe::ShippingRate, Int32, Hash(String, Array(String) | String))
<p>Creates a new shipping rate object.</p> @required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of your shipping rates.
@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 created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. @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 currency [String?] Only return shipping rates for the given currency. @optional @param active [Bool?] Only return shipping rates that are active or inactive. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ShippingResourcesShippingRateList]<p>Returns a list of your shipping rates.</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 created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
@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 currency [String?] Only return shipping rates for the given currency.
@optional @param active [Bool?] Only return shipping rates that are active or inactive.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Returns the shipping rate object with the given ID.
@required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ShippingRate]<p>Returns the shipping rate object with the given ID.</p> @required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Returns the shipping rate object with the given ID.</p> @required @param shipping_rate_token [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ShippingRate, Integer, Hash)] Stripe::ShippingRate, response status code and response headers
<p>Returns a list of your shipping rates.</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 created [Stripe::GetAccountsCreatedParameter?] A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
@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 currency [String?] Only return shipping rates for the given currency.
@optional @param active [Bool?] Only return shipping rates that are active or inactive.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ShippingResourcesShippingRateList, Integer, Hash)] Stripe::ShippingResourcesShippingRateList, response status code and response headers
Creates a new shipping rate object.
@required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. @optional @param delivery_estimate [Stripe::DeliveryEstimate?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param fixed_amount [Stripe::FixedAmount?] @optional @param metadata [Hash(String, String)?] @optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @optional @param tax_code [String?] A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. @optional @param _type [String?] The type of calculation to use on the shipping rate. @return [Stripe::ShippingRate]<p>Creates a new shipping rate object.</p>
@required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
@optional @param delivery_estimate [Stripe::DeliveryEstimate?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param fixed_amount [Stripe::FixedAmount?]
@optional @param metadata [Hash(String, String)?]
@optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
@optional @param tax_code [String?] A tax code ID. The Shipping tax code is txcd_92010001.
@optional @param _type [String?] The type of calculation to use on the shipping rate.
@return nil
Updates an existing shipping rate object.
@required @param shipping_rate_token [String?] @optional @param active [Bool?] Whether the shipping rate can be used for new purchases. Defaults to `true`. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param fixed_amount [Stripe::FixedAmountUpdate?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. @return [Stripe::ShippingRate]<p>Updates an existing shipping rate object.</p>
@required @param shipping_rate_token [String?]
@optional @param active [Bool?] Whether the shipping rate can be used for new purchases. Defaults to true.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param fixed_amount [Stripe::FixedAmountUpdate?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
@return nil
<p>Updates an existing shipping rate object.</p>
@required @param shipping_rate_token [String?]
@optional @param active [Bool?] Whether the shipping rate can be used for new purchases. Defaults to true.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param fixed_amount [Stripe::FixedAmountUpdate?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
@return [Tuple(Stripe::ShippingRate, Integer, Hash)] Stripe::ShippingRate, response status code and response headers
<p>Creates a new shipping rate object.</p>
@required @param display_name [String?] The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
@optional @param delivery_estimate [Stripe::DeliveryEstimate?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param fixed_amount [Stripe::FixedAmount?]
@optional @param metadata [Hash(String, String)?]
@optional @param tax_behavior [String?] Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
@optional @param tax_code [String?] A tax code ID. The Shipping tax code is txcd_92010001.
@optional @param _type [String?] The type of calculation to use on the shipping rate.
@return [Tuple(Stripe::ShippingRate, Integer, Hash)] Stripe::ShippingRate, response status code and response headers