<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug StripeConnect > Subscription > CancelSubscription |
Annulla una Subscription a pagamenti ricorrenti verso un destinatario.
Metodo
PlugStripeConnect/CancelSubscription
Input |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
serverAddress |
Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto). |
String |
Y |
token |
Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto). |
String |
Y |
recipientReference |
Collegamento all'identità o elemento organizzativo che riceve i pagamenti. |
Reference |
|
subscriptionId |
Identificativo della Subscription da annullare. |
String |
|
subscriptionData |
Proprietà della Subscription. L'elenco dei parametri che possono essere inseriti è consultabile qui. |
Dataset |
Y |
testMode |
True se è richiesta l'esecuzione del metodo in modalità test di Stripe. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live di Stripe. La modalità testMode indicata deve essere ammessa dalla configurazione. |
Boolean |
Y |
Output |
|
||
Nome |
Descrizione |
Tipo |
|
returnValue |
Dato strutturato che rappresenta la Subscription annullata. L'elenco delle proprietà è consultabile qui. |
Dataset |
|
Commenti
Il metodo si comporta come segue:
Restituisce |
Condizione |
Errore |
Se testMode è valorizzato e non è presente, per l'identità o l'elemento organizzativo a cui fa riferimento RecipientReference, una configurazione che permette la chiamata nella modalità TestMode indicata. |
Errore |
Se non presente per il RecipientReference una configurazione che permette la chiamata nella modalità TestMode. |
Errore |
Se per il RecipientReference non esiste un metodo di pagamento. |
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug Stripe Connect.