TDV Adapter for Shopify

Build 24.0.9060

RecurringApplicationCharges

Create, update, delete, and query Recurring Application Charges.

Table-Specific Information

Select

The adapter processes all filters client-side within the adapter. The following queries are the only ones processed server-side:
SELECT * FROM RecurringApplicationCharges

SELECT * FROM RecurringApplicationCharges WHERE Id = '123'

Update


UPDATE RecurringApplicationCharges SET Test = 'true', Name = 'cd' WHERE Id = '2'

Delete

You must specify the Id of the recurring application charge to delete it.

DELETE FROM RecurringApplicationCharges WHERE Id = '2'

Columns

Name Type ReadOnly References Description
Id [KEY] Long False

The ID of the recurring application charge.

Name String False

The name of the recurring application charge.

ApiClientId String False

The API Client Id

Price Decimal False

The price of the recurring application charge. The maximum price is 10,000.

Status String False

The status of the recurring charge

ReturnUrl String False

The URL where the merchant is redirected after accepting the charge.

BillingOn Date False

The date and time (ISO 8601 format) when the customer was billed.

Test String False

Whether the application charge is a test transaction.

CreatedAt Datetime False

The date and time (ISO 8601 format) when the recurring application charge was created.

UpdatedAt Datetime False

The date and time (ISO 8601 format) when the recurring application charge was last updated.

ActivatedOn Datetime False

The date and time (ISO 8601 format) when the customer activated the recurring application charge.

CancelledOn Datetime False

The date and time (ISO 8601 format) when the merchant canceled their recurring application charge.

TrialDays Int False

The number of days that the customer is eligible for a free trial.

TrialEndsOn Datetime False

The date and time (ISO 8601 format) when the free trial ends.

DecoratedReturnUrl String False

The decorated return url.

CappedAmount String False

The limit a customer can be charged for usage based billing. If this property is provided, then you must also provide the terms property.

ConfirmationUrl String False

The URL where the merchant accepts or declines the recurring application charge.

Terms String False

The terms and conditions of usage based billing charges. Must be present in order to create usage charges,

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