useSubscription

this page's documentation only applies to chord's next js starter prior to the release of the react docid\ ewxkrz0jhh0zpphikkcri the next js starter now uses the react sdk and does not use the methods documented on this page check out the react sdk reference for complete documentation, and the react sdk migration guide docid\ qmilhjfpz9wbjyzbe50ku for details on how to upgrade the usesubscription hook returns the current loaded subscription and functions for managing the subscription example import { usesubscription } from ' /hooks/actions' export default () => { const { subscription } = usesubscription() return ( \<p>your subscription will be renewed on {subscription actionabledate}\</p> ) } import { usesubscription } from ' /hooks/actions' // inside a function component const { subscripion, loadsubscription } = usesubscription() returns the usesubscription hook returns an object with these properties 389,354 trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type functions loadsubscription the loadsubscription function loads information about the subscription from the chord api arguments loadsubscription(subscriptionid) trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default subscriptionid => { const { subscription, loadsubscription } = usesubscription() useeffect(() => { loadsubscription(subscriptionid) }, \[]) return ( \<p>your subscription will be renewed on {subscription actionabledate}\</p> ) } skipsubscription the skipsubscription function calls the chord api to skip the next subscription delivery arguments none returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default subscriptionid => { const { subscription, skipsubscription } = usesubscription() useeffect(() => { skipsubscription() }, \[]) return ( \<p>your subscription will be renewed on {subscription actionabledate}\</p> ) } cancelsubscription the cancelsubscription function calls the chord api to cancel a subscription arguments none returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default subscriptionid => { const { subscription, cancelsubscription } = usesubscription() useeffect(() => { cancelsubscription() }, \[]) return \<p>your subscription was canceled\</p> } pausesubscription the pausesubscription function calls the chord api to pause a subscription paused subscriptions will not be processed until manually resumed or the actionabledate is reached arguments pausesubscription(options) trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default () => { const { pausesubscription } = usesubscription(subscription id) const onsubmit = async data => { try { let response = await pausesubscription({ 'actionabledate' '2030 08 18' }) console log(response) } catch (error) { console error(error) } } } resumesubscription the resumesubscription function calls the chord api to resume a subscription paused subscriptions will not be processed until manually resumed or the actionabledate is reached arguments resumesubscription(options) trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default () => { const { resumesubscription } = usesubscription(subscription id) const onsubmit = async data => { try { let response = await resumesubscription({ 'actionabledate' '2030 08 18' }) console log(response) } catch (error) { console error(error) } } } updatesubscription the updatesubscription function calls the chord api to update a subscription arguments updatesubscription(options) 284,130,328 trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type returns promise\<subscription> a promise that resolves with the subscription example import { usesubscription } from ' /hooks/actions' export default () => { const { updatesubscription } = usesubscription(subscription id) const onsubmit = async data => { try { let response = await updatesubscription({ 'shipaddressattributes' data addressattributes, 'billaddressattributes' data addressattributes, 'intervalunits' 'month', 'intervallength' 2, 'enddate' '2021/12/31', 'actionabledate' '2030 08 18' }) console log(response) } catch (error) { console error(error) } } } / default form values const address = subscription\['shipaddress'] const addressattributes = { name address name, address1 address address1, address2 address address2, city address city, state name address state abbr, country iso address country iso, zipcode address zipcode } /