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

Dato strutturato contenente le proprietà della Subscription.

L'elenco dei parametri che possono essere inseriti è consultabile qui.

Dataset

Y

subscriptionMetadata

Dato strutturato contenente dati aggiuntivi utili a valorizzare i metadati. Non può contenere dati annidati o liste. Può contenere massimo 50 campi, con nomi di campo lunghi fino a 40 caratteri e valori di tipo stringa lunghi fino a 500 caratteri.

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

paymentMethodReference

Collegamento al PaymentMethod. Esso deve essere attivo per la recipientReference.

Il parametro non è obbligatorio, in quanto può essere specificato nel parametro subscriptionData, nel campo default_payment_method. Nel caso siano entrambi valorizzati, esso viene sostituito con il valore specificato in questo parametro.

Reference

Y

Output

Nome

Descrizione

Tipo

returnValue

Dato strutturato che contiene la Subscription aggiornata.

Dataset

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 tutti i parametri subscriptionData, subscriptionMetadata e paymentMethodReference non sono specificati.

Errore

Se la Subscription da aggiornare non è presente.

Errore

Se il parametro subscriptionData contiene il campo default_payment_method, ma non viene valorizzato o PaymentMethod non è attivo per il Customer su quel determinato Recipient.