Interface: UseSubscription

module react autonomy docid\ zoz6w56ubppacr0po0gls usesubscription usesubscription contains all the data and methods returned by the function usesubscription docid 1ver5hm0sfxaui6bjuh9z hook properties cancelsubscription • cancelsubscription ( options? interface cancelsubscription docid\ smv1lavtpbivc8k90el3o ) => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ ( options? ) promise < interface subscription docid\ loyadm9adkrjfnxzszfya > the cancelsubscription function calls the chord api to cancel the subscription import { usesubscription } from '@chordcommerce/react autonomy' export default subscriptionid => { const { subscription, cancelsubscription } = usesubscription({ subscriptionid }) const onclick = async () => { return cancelsubscription() } return \<button onclick={onclick}>cancel subscription\</button> } parameters name type options? interface cancelsubscription docid\ smv1lavtpbivc8k90el3o returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 205 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l205 error • error error defined in packages/react autonomy/src/hooks/use subscription ts 122 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l122 isfetching • isfetching boolean defined in packages/react autonomy/src/hooks/use subscription ts 124 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l124 isloaded • isloaded boolean defined in packages/react autonomy/src/hooks/use subscription ts 123 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l123 loadsubscription • loadsubscription () => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ () promise < interface subscription docid\ loyadm9adkrjfnxzszfya > the loadsubscription function loads information about the subscription from the chord api you shouldn't need to call this function, except in exceptional circumstances, as the function usesubscription docid 1ver5hm0sfxaui6bjuh9z hook will automatically start loading the subscription when the hook is initialized here's an example of when you might want to use loadsubscription in a custom callback it should be noted that skipsubscription returns the updated subscription, but in this example, assume that it doesn't for educational purposes import { usesubscription } from '@chordcommerce/react autonomy' import customeventingfunction from ' /app/events' const skipsubscriptionbuton = ({ subscriptionid }) => { const { subscription, loadsubscription, skipsubscription } = usesubscription({ subscriptionid }) const handleclick = async () => await skipsubscription() const updatedsubscription = await loadsubscription() await customeventingfunction('subscription skipped', { newenddate updatedsubscription enddate, }) } return \<button onclick={handleclick}>skip\</button> } returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 163 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l163 pausesubscription • pausesubscription ( options interface pausesubscription docid\ qqnvonlbd1nympybanckp ) => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ ( options ) promise < interface subscription docid\ loyadm9adkrjfnxzszfya > the pausesubscription function calls the chord api to pause a subscription import { usesubscription } from '@chordcommerce/react autonomy' export default subscriptionid => { const { subscription, pausesubscription } = usesubscription({ subscriptionid }) const onclick = async () => { return pausesubscription({ actionabledate new date() toisostring() }) } return \<button onclick={onclick}>pause subscription\</button> } parameters name type options interface pausesubscription docid\ qqnvonlbd1nympybanckp returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 271 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l271 resumesubscription • resumesubscription ( options interface resumesubscription docid\ lidcfvnakoobaf7xpaloo ) => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ ( options ) promise < interface subscription docid\ loyadm9adkrjfnxzszfya > 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 import { usesubscription } from '@chordcommerce/react autonomy' export default subscriptionid => { const { subscription, resumesubscription } = usesubscription({ subscriptionid }) const onclick = async () => { return resumesubscription({ actionabledate new date() toisostring() }) } return \<button onclick={onclick}>resume subscription\</button> } parameters name type options interface resumesubscription docid\ lidcfvnakoobaf7xpaloo returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 295 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l295 skipsubscription • skipsubscription ( options? interface skipsubscription docid 0mrrulvz7gsh1qdivfbtx ) => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ ( options? ) promise < interface subscription docid\ loyadm9adkrjfnxzszfya > the skipsubscription function calls the chord api to skip the next subscription delivery import { usesubscription } from '@chordcommerce/react autonomy' export default subscriptionid => { const { subscription, skipsubscription } = usesubscription({ subscriptionid }) const onclick = () => { skipsubscription() } return \<button onclick={onclick}>skip next shipment\</button> } parameters name type options? interface skipsubscription docid 0mrrulvz7gsh1qdivfbtx returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 184 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l184 subscription • subscription interface subscription docid\ loyadm9adkrjfnxzszfya defined in packages/react autonomy/src/hooks/use subscription ts 121 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l121 updatesubscription • updatesubscription ( options interface subscriptionupdateprops docid\ phpumfzbeo5wqt93bmacb ) => promise < interface subscription docid\ loyadm9adkrjfnxzszfya > type declaration ▸ ( options ) promise < interface subscription docid\ loyadm9adkrjfnxzszfya > the updatesubscription function calls the chord api to update a subscription import { usesubscription } from '@chordcommerce/react autonomy' export default () => { const { updatesubscription } = usesubscription(subscription id) const onsubmit = async data => { try { let response = await updatesubscription({ shipaddressattributes data addressattributes, billaddressattributes data addressattributes, intervallength 2, intervalunits 'month', 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 } parameters name type options interface subscriptionupdateprops docid\ phpumfzbeo5wqt93bmacb returns promise < interface subscription docid\ loyadm9adkrjfnxzszfya > defined in packages/react autonomy/src/hooks/use subscription ts 248 https //github com/chordcommerce/chord ui/blob/2b105e1/packages/react autonomy/src/hooks/use subscription ts#l248