TDV Adapter for Stripe

Build 24.0.9060

ShippingRates

Query the available Shipping rates in Stripe.

Table Specific Information

Select

The adapter uses the Stripe API to filter the results by the following columns and operators:

  • Id supports the following operator: =.
  • Active supports the following operator: =.
  • Created supports the following operator: =,>,>=,<,<=.
  • AccountId supports the following operator: =.
  • FixedAmountCurrency supports the following operator: =.

The rest of the filter is executed client-side within the adapter.

You can select from the ShippingRates table with the following queries:

SELECT * FROM ShippingRates WHERE Id = 'shr_1MHKKGSC4snQ4WkONC7OYQuS'
SELECT * FROM ShippingRates WHERE Id = 'shr_1MHKKGSC4snQ4WkONC7OYQuS' AND AccountId = 'acct_1MGcyqSC4snQ4WkO'

Insert

DisplayName and Type are required to create a ShippingRate:

INSERT INTO ShippingRates(DisplayName,Type,MetadataAggregate,FixedAmountAmount,FixedAmountCurrency) values ('asdsswd','fixed_amount','[{\"nsame\":\"asdsa\"}]',230,'usd')

Update

To update a shipping rate, specify the Id:

UPDATE ShippingRates SET Active = true WHERE Id = 'shr_1OQ9ScCZ8rn6qR6h3H86TWDn'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the Shipping Rates.

Active Boolean False

Whether the shipping rate can be used for new purchases. Its default value is true.

Created Timestamp True

Time at which the object was created. Measured in seconds since the Unix epoch.

DeliveryEstimateMaximumUnit String False

A unit of time.

DeliveryEstimateMaximumValue Integer False

Must be greater than 0.

DeliveryEstimateMinimumUnit String False

A unit of time.

DeliveryEstimateMinimumValue Integer False

Must be greater than 0.

DisplayName String False

The name of the shipping rate, meant to be displayable to the customer.

FixedAmountAmount Integer False

A non-negative integer in cents representing how much to charge.

FixedAmountCurrency String False

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Livemode Boolean True

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

MetadataAggregate String False

Set of key-value pairs

Object String True

The Object type.

TaxBehavior String False

Whether the rate is considered inclusive of taxes or exclusive of taxes.

TaxCode String False

Tax code Id.

Type String False

The type of calculation to use on the shipping rate.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AccountId String

The Id of the connected account.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060