<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug StripeConnect > InvoiceItem > UpdateInvoiceItem |
Aggiorna l'importo o la descrizione di un InvoiceItem nella piattaforma di pagamento Stripe.
Metodo
PlugStripeConnect/UpdateInvoiceItem
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 |
|
invoiceItemId |
Identificativo dell’InvoiceItem da aggiornare. |
String |
|
invoiceItemData |
Dato strutturato contenente i dati dell’InvoiceItem da aggiornare. L'elenco dei parametri che possono essere inseriti è consultabile qui. Tra questi è obbligatorio il parametro customer che viene ricavato in automatico dalla customerReference. |
Dataset |
|
invoiceItemMetadata |
Dato strutturato contenente dati aggiuntivi utili a valorizzare i metadati dell’InvoiceItem. 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 |
Output |
|
||
Nome |
Descrizione |
Tipo |
|
returnValue |
Dato strutturato contenente le informazioni dell’InvoiceItem aggiornato. |
Dataset |
|
Commenti
L'aggiornamento di un InvoiceItem è possibile solo prima della chiusura dell'Invoice a cui è allegato.
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 l’InvoiceItem non esiste. |
Errore |
Se il price indicato nel dato strutturato del parametro invoiceItemData è di tipo ricorrente o nullo. |
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug Stripe Connect.