UpdateProduct

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug StripeConnect > Product >

UpdateProduct

Aggiorna un Product definito nella piattaforma Stripe.

 

Metodo

PlugStripeConnect/UpdateProduct

 

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

productId

Identificativo del Product in Stripe.

String

 

recipientReference

Collegamento all'identità o elemento organizzativo che riceve i pagamenti.

Reference

 

productData

Dato strutturato contenente i dati del Product da aggiornare

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

Dataset

Y

productMetadata

Dato strutturato contenente dati aggiuntivi utili ad aggiornare i metadati del Product. 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 l'entità Product aggiornata.

Dataset

 

 

Commenti

Se il parametro priceMetadata contiene stringhe vuote, i rispettivi valori eventualmente già presenti nel price vengono sovrascritti.

 

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.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Utilizzo sulla configurazione del Plug Stripe Connect.