Update Subscription

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

string
required
Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

string
required
Defaults to 2412333540

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

string
required
Defaults to 46792

Unique identifier of the subscription.

string
required
Defaults to 10

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99). A request should not be sent when the amount is 0. The amount must be greater than zero

string
Defaults to 1

Additional surcharge fee amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).

string
Defaults to 0

Tax amount to be applied to the transaction. Must be provided as a currency amount in USD (e.g., 10.00).

payment_info
object
required

Provide any one of the following payment methods: vault_id with payment_id, card details, or a token.

string
required
Defaults to 0

Set 0 for transactions processed through a traditional MID with no custom fee. Set 1 for transactions processed through a cash discounting MID with a custom fee.

string
required
Defaults to 2

Set the recurring type.

Recurring TypeOptions
Weekly0
Bi-Weekly1
Monthly2
Quarterly3
Annually4
Daily5
Run at6

string
required
Defaults to 0

Set 1 for card validation only without charging. Set 0 to process the payment for the current billing cycle.

string

Name of the cardholder. Must contain alphabetic characters only and have a maximum length of 25 characters.

string

The descriptor must not exceed 25 characters.

string

Description of the product max 50 chars

string

Invoice number field must contain a maximum of 12 characters and may include only alphanumeric characters. < and > are not allowed.

string

Customer field must contain a maximum of 100 characters and may include only alphanumeric characters, #, and @.

string
required
Defaults to John Doe

Customer Name - Alphabet (Max length of max 25 chars)

string
Defaults to 3636

Street number, which may include a hyphen (e.g., 1-95).

string
Defaults to 33rd street

Street name - Alphanumeric (Length of 50 chars)

string
Defaults to 206

Street unit (Ex. block, apartment) - Max length of 25 chars

string
Defaults to ASTORIA

City should be allowed max 50 chars of string (Ex: New York, San Francisco)

string
Defaults to NY

State 2 chars of capital (Ex: New York - NY, California - CA)

string
required
Defaults to 11106

Must be a valid US ZIP code. Example: 55427

string
Defaults to John Doe

Shipping customer name - Alphabet (Max length of 25 chars)

string
Defaults to 3636

Street number, which may include a hyphen (e.g., 1-95).

string
Defaults to 33rd street

Street name - Alphanumeric (Length of 50 chars)

string
Defaults to 206

Street unit (Ex. block, apartment) - Max length of 25 chars

string
Defaults to ASTORIA

City should be allowed max 50 chars of string (Ex: New York, San Francisco)

string
Defaults to NY

State 2 chars of capital (Ex: New York - NY, California - CA)

string
Defaults to 11106

Must be a valid US ZIP code. Example: 55427

string
required
Defaults to 2026-12-25

Subscription start payment date accepted expiry YYYY-MM-DD

string

Customer phone number- 10 digit Numeric (Ex: 5247896523)

string

Customer email id - Varchar (Ex: [email protected], Max length of 50 chars)

string
required
Defaults to 25

If recurring type 0-Weekly or 1-Bi-Weekly this should be any value from 0 to 6 else if recurring type 2, 3, 4, 5, 6 it accept any value from 1 to 30 Days in month

string
Defaults to 0

Set 1 to enable failure notifications. Set 0 to disable failure notifications.

string
Defaults to 1

Specifies the maximum number of retry attempts for recurring payments that fail due to insufficient funds, with a maximum value of 10. If set to 2, the payment will be retried on the next day and the following day.

additional_prompts
object

Custom inputs, with a maximum of 25 entries allowed.

string

For installment transactions, the payment type will be sent as 2

notification_preference
object

Specifies the payment reminder notification preferences for the subscription, including the notification frequency, reminder timing, and recipient. If notification preferences are configured when creating the subscription, payment reminder emails will be sent to the customer based on the configured settings.

string

Set to 1 to enable duplicate transaction checking based on the portal setting. Set to 0 to disable it. For example, By Invoice Number declines transactions with the same invoice number in the same batch.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json