v1.1

Update subscription recurring cycles

Update subscription remaining recurring cycles

post/api/v1.4/subscriptions/{subscription_id}/update_remaining_recurring_cycles/

Path parameters

subscription_idstring required

A unique identifier for subscription.

Request body

remaining_recurring_cyclesinteger nullable required

Number of remaining recurring cycles in the subscription life time, null if the subscription is forever.

Response

idstring required

accountobject required

planobject required

Plan ID subscription attached to.

current_statusobject required

Subscription current status.

start_datestring date

Start date of subscription trial or subscription first cycle.

customerobject required

Customer UUID attached to the subscription.

charge_automaticallyboolean

Determine if the subscription invoice will be charged automatically using card token.

primary_card_tokenstring nullable required

remaining_recurring_cyclesinteger nullable

Number of remaining recurring cycles in the subscription life time, null if the subscription is forever.

remaining_discount_cyclesinteger nullable

Number of recurring cycles to apply discount to, null if there is no discount.

configurationobject required

Subscription configuration attached to subscription.

webhook_urlstring uri nullable

A URL that the Moneyhash server will send a POST request to with subscription status updates.

{"stackTrail":"components:schemas:SubscriptionDetails:properties:custom_fields","oasType":"schema","type":"unknown","description":"Key value pairs of any additional information you want to save with the subscription.","nullable":true}

due_invoicesobject[] required

Due invoices to be paid.

next_recurring_cycle_invoiceobject required

Start date of the next recurring cycle, null if the current date less than start date

all_invoicesobject required

All invoices related to this subscription.

is_liveboolean required

end_datestring required

createdstring date-time required

payment_redirectsobject nullable required

Payment redirect URLs from plan group level.

flowobject nullable required

The data of the payment flow attached to the subscription if exists.

card_tokenization_payment_intentobject nullable required

The subscription payment intent that is used for card tokenization when charge_automatically is true and primary_card_token is not provided in the subscription creation

Changes

No recorded changes to this endpoint across all 1 revision of this API.