Spaceport Documentation home page
Search...
⌘K
Website
Blogs
Types
Core Types
Agreement
Asset
Listing
SmartLicense
User
Product
Invoice
Request/Response Types
Filter & Query Types
Payment & Royalty Types
Utility Types
All Types
AcceptDenyRoyaltiesInput
AcceptRoyaltiesParams
AgreementFilters
AgreementObject
Agreement
AgreementsResponse
AssetMetadata
Asset
AttestationInfo
BatchCreateAssetsParams
BatchCreateAssetsResponse
BatchListingInput
CoreAgreementAsset
CoreAgreement
CoreAsset
CoreListing
CreateAgreementInput
CreateAndSignParams
CreateAndSignResponse
CreateAssetParams
CreateAssetResponse
CreateInvoicesParams
CreateListingApiParams
CreateListingInput
CreateListingParams
CreateProductParams
CreateProductResponse
CreateUserInput
CreateUserParams
CreateUserResponse
DenyRoyaltiesParams
EthereumProvider
FetchInvoicesParams
FindProductParams
GenerateInvoiceCSVOptions
GeneratedInvoiceCSV
GetAgreementAssetsParams
GetAgreementAssetsResponse
GetAgreementsParams
GetAgreementsResponse
GetUserByWalletParams
GetUserByWalletResponse
ImportInvoicesParams
ImportInvoicesResponse
Invoice
JobStatusOptions
JobStatusResponse
LicenseTypeValue
License
ListingFilters
ListingObject
Listing
ListingsResponse
MintAssetInput
MintResult
OffChainPaymentStatus
OffchainAcceptanceDenialResponse
OffchainPaymentResponse
PageInfo
PaginationParams
ParentDigitalAsset
PayOffchainRoyaltiesInput
PayOffchainRoyaltyItemParams
Product
RegisterRoyaltiesParams
RegisterRoyaltiesResponse
RoyaltiesResponse
RoyaltyObject
RoyaltyOffChainPaymentAcceptedObject
RoyaltyOffchainPaymentSubmitedObject
RoyaltyRegistrationSignatureParams
SignatureParams
SmartLicenseObject
SmartLicense
SmartLicensesResponse
SpaceportConfig
SpaceportError
TermsObject
Terms
TransactionReceipt
TransactionResponse
TransformInvoicesOutput
TransformOffchainAcceptanceOutput
TransformOffchainDenialOutput
TransformOffchainPaymentOutput
User
VerifyAssetParams
Support
Home
Spaceport Documentation home page
Search...
⌘K
Ask AI
Support
Home
Home
Search...
Navigation
Core Types
Interface: Agreement
Documentation
SDK Guide
Type Reference
Documentation
SDK Guide
Type Reference
Core Types
Interface: Agreement
index
.Agreement
Table of contents
Properties
agreementId
listingId
licensee
licensor
stage
startTime
endTime
paymentToken
paymentAmount
paymentReceived
docURI
Properties
agreementId
•
agreementId
:
bigint
listingId
•
listingId
:
bigint
licensee
•
licensee
: `0x${string}`
licensor
•
licensor
: `0x${string}`
stage
•
stage
:
number
startTime
•
startTime
:
bigint
endTime
•
endTime
:
bigint
paymentToken
•
paymentToken
: `0x${string}`
paymentAmount
•
paymentAmount
:
bigint
paymentReceived
•
paymentReceived
:
bigint
docURI
•
Optional
docURI
:
string
Asset
Next
On this page
Table of contents
Properties
Properties
agreementId
listingId
licensee
licensor
stage
startTime
endTime
paymentToken
paymentAmount
paymentReceived
docURI
Assistant
Responses are generated using AI and may contain mistakes.