Split on subscriptions

The only difference between creating a subscription with and without Split is in the submission of the split array in the subscription creation request. This array is called split and contains the list of walletId objects and values to be transferred when the charge is received.

{
    ...
    "split":[
        {
            "walletId":"48548710-9baa-4ec1-a11f-9010193527c6",
            "fixedValue":20.00
        },
        {
            "walletId":"0b763922-aa88-4cbe-a567-e3fe8511fa06",
            "percentualValue":10.00
        }
    ]
}

🚧

The split configured in the subscription will serve as a template, which will be used in the creation of each new charge.

Update Subscription Split

To update the split, simply retrieve the subscription ID and use the Update Subscription method to perform the update and inform the new split attributes.

{
    ...
    "split":[
        {
            "walletId":"48548710-9baa-4ec1-a11f-9010193527c6",
            "fixedValue":10.00
        }
    ]
}

🚧

When updating a subscription, if you do not want to change the Split settings, do not include the split parameter in the request, because passing null or [] will deactivate the Split.

Charges already generated will not be updated. To update the split of charges already generated, it will be necessary to do it manually on each charge of the subscription, updating the charges.

Consult Split in Subscription

To consult the split settings of a specific subscription, you can use the List Subscriptions method or Retrieve a Single Subscription.