Update Subscription

put

https://api.eukapay.com/subscriptions/{code}

Update a subscription

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

code

string

required

Defaults to sub_75zbe4jUFXxyvYpU0suIt3QJqv

The subscription code

Body Params

price

double

Defaults to 7.82

The price of the subscription. The minimum subscription price is 1 and the maximum subscription price is 100,000

currencyId

int32

Defaults to 1

The currency id to create the subscription with. Supported currencies are here https://docs.eukapay.com/docs/supported-currencies

customerCode

string

Defaults to cus_cNk3QiusT0i53wBNxWI94Y9Ymp

The code of the customer the subscription is to be created for. If total subscription price is greater than or equal to 1,000, fields address1, city, state, country are required in the customer object.

interval

string

Defaults to Monthly

The interval at which the recurring payment will be requested. The intervals are 'Daily', 'Weekly', 'Bi-weekly', 'Semi-monthly', 'Monthly', 'Quarterly', 'Semi-annually', 'Annually'

startImmediately

boolean

Defaults to true

The first invoice is created immediately and included in the invoices data. In this case, the startDate and the nextDate are not be able to set.

startDate

date

Defaults to 2024-02-28

The start date of the subscription. The format is YYYY-MM-DD.

endDate

date

Defaults to 2024-04-28

The end date of the subscription. The format is YYYY-MM-DD.

nextDate

date

Defaults to 2024-03-28

The next date of the subscription. The date that the first payment request will be sent. The format is YYYY-MM-DD.

message

string

Defaults to Updated subscription

Additional message to describe subscription.

redirectUri

string

Defaults to https://example.com/subscriptionPaid

The url to redirect to once payment is completed.

shipping

double

Defaults to 2.33

The amount for shipping.

tax

double

Defaults to 12

The amount for tax.

discount

double

Defaults to 2

The discount amount.

subscriptionItems

array of objects

The subscription items for this subscription.

subscriptionItems

subscriptionTaxes

array of objects

The subscription taxes for this subscription.

subscriptionTaxes

subscriptionDiscounts

array

The subscription discounts for this subscription.

subscriptionDiscounts

Headers

x-idempotent-key

string

Responses

200200

400400