fix: Update cash balance methods to no longer require nested ID. #1063
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates
Customer.retrieve_cash_balance
andCustomer.update_cash_balance
methods to no longer require a nested ID.Previously you always had to call with
nil
as the second parameter (eg.retrieve_cash_balance('cus_123', nil)
).With this PR, the second parameter is
nil
by default.Changes to
retrieve_cash_balance
You can now use
retrieve_cash_balance
with the following call patterns:retrieve_cash_balance(customer_id, nil[, opts])
retrieve_cash_balance(customer_id[, opts])
Changes to
update_cash_balance
You can now use
update_cash_balance
with the following call patterns:update_cash_balance(customer_id, nil[, params[, opts]])
update_cash_balance(customer_id)
(admittedly this isn't very useful in isolation)We raise an error if trying to do
update_cash_balance(customer_id, some hash)
since we don't want users to accidentally use this thinking the signature isupdate_cash_balance(customer_id, params)
. We unfortunately can't gracefully support both the legacy pattern andupdate_cash_balance(customer_id, params, opts)
since we wouldn't be able to differentiateupdate_cash_balance(customer_id, nil, hash)
(is has here aparams
oropts
?).Future major
In a future major, we could remove the nested_id nil parameter entirely and bring this back to a consistent syntax with our other APIs.